moduleceylon.buffer1.3.3
Source Code
ceylon.buffer.codec
interfaceIncrementalCodec<ToMutable, ToImmutable, ToSingle, FromMutable, FromImmutable, FromSingle>
satisfies StatelessCodec<ToMutable,ToImmutable,ToSingle,FromMutable,FromImmutable,FromSingle>
given ToMutable satisfies Buffer<ToSingle>
given ToImmutable satisfies {ToSingle*}
given FromMutable satisfies Buffer<FromSingle>
given FromImmutable satisfies {FromSingle*}
OverviewPackageAttributesMethods

Codecs that can process input into output in portions of the whole.

no type hierarchy

Inherited Attributes
Attributes inherited from: Object
hash, string
Attributes inherited from: Codec
aliases, name
Methods
chunkDecoderSource Codeshared ChunkConvert<FromMutable,FromSingle,ToSingle> chunkDecoder(ErrorStrategy error = ...)

Decodes in portions dictated by the size of the output buffer, which will not be resized.

Parameters:
  • error = strict
Throws
chunkEncoderSource Codeshared ChunkConvert<ToMutable,ToSingle,FromSingle> chunkEncoder(ErrorStrategy error = ...)

Encodes in portions dictated by the size of the output buffer, which will not be resized.

Parameters:
  • error = strict
Throws
cumulativeDecoderSource Codeshared formal CumulativeConvert<FromMutable,{ToSingle*},FromSingle,ToSingle> cumulativeDecoder(Integer? inputSize = null, Float growthFactor = ..., ErrorStrategy error = ...)

Decode into a new buffer as portions arrive and return the buffer when the input is complete. inputSize can be used to hint the expected total size of the input, to avoid resizing the output buffer unnecessarily.

Parameters:
  • inputSize = null
  • growthFactor = 1.5
  • error = strict
cumulativeEncoderSource Codeshared formal CumulativeConvert<ToMutable,{FromSingle*},ToSingle,FromSingle> cumulativeEncoder(Integer? inputSize = null, Float growthFactor = ..., ErrorStrategy error = ...)

Encode into a new buffer as portions arrive and return the buffer when the input is complete. inputSize can be used to hint the expected total size of the input, to avoid resizing the output buffer unnecessarily.

Parameters:
  • inputSize = null
  • growthFactor = 1.5
  • error = strict
decodeBidSource Codeshared formal Integer decodeBid({ToSingle*} sample)

The certainty that that the given sample is suitable for decoding with this codec.

A number 1 or greater indicates that (based on the sample at least) the input should decode without error. The higher the number is beyond 1, the more appropriate this codec is likely to be.

encodeBidSource Codeshared formal Integer encodeBid({FromSingle*} sample)

The certainty that that the given sample is suitable for encoding with this codec.

A number 1 or greater indicates that (based on the sample at least) the input should encode without error. The higher the number is beyond 1, the more appropriate this codec is likely to be.

pieceDecoderSource Codeshared formal PieceConvert<FromSingle,ToSingle> pieceDecoder(ErrorStrategy error = ...)

Decodes one output piece to zero or more input pieces. This is mostly intended for refinement by subtypes. Higher level decode methods are provided for general use.

Parameters:
  • error = strict
Throws
pieceEncoderSource Codeshared formal PieceConvert<ToSingle,FromSingle> pieceEncoder(ErrorStrategy error = ...)

Encodes one input piece to zero or more output pieces. This is mostly intended for refinement by subtypes. Higher level encode methods are provided for general use.

Parameters:
  • error = strict
Throws
Inherited Methods
Methods inherited from: Object
equals()
Methods inherited from: Codec
averageDecodeSize(), averageEncodeSize(), maximumDecodeSize(), maximumEncodeSize()
Methods inherited from: StatelessCodec<ToMutable,ToImmutable,ToSingle,FromMutable,FromImmutable,FromSingle>
decode(), decodeBuffer(), encode(), encodeBuffer()