io.servicetalk.encoding.api

Interface ContentCodec

public interface ContentCodec

API to support encode and decode of Buffers.

Implementations must provide thread safety semantics, since instances could be shared across threads.

Method Summary

Modifier and Type	Method and Description
default Buffer	decode(Buffer src, BufferAllocator allocator) Take a Buffer and decode its contents resulting in a Buffer with the decoded content.
Buffer	decode(Buffer src, int offset, int length, BufferAllocator allocator) Take a Buffer and decode its contents resulting in a Buffer with the decoded content.
Publisher<Buffer>	decode(Publisher<Buffer> from, BufferAllocator allocator) Take a Publisher of Buffer and encode its contents resulting in a Publisher of Buffer with the decoded contents.
default Buffer	encode(Buffer src, BufferAllocator allocator) Take a Buffer and encode its contents resulting in a Buffer with the encoded contents.
Buffer	encode(Buffer src, int offset, int length, BufferAllocator allocator) Take a Buffer and encode its contents resulting in a Buffer with the encoded contents.
Publisher<Buffer>	encode(Publisher<Buffer> from, BufferAllocator allocator) Take a Publisher of Buffer and encode its contents resulting in a Publisher of Buffer with the encoded contents.
CharSequence	name() A unique textual representation for the coding.

Method Detail

name

CharSequence name()

A unique textual representation for the coding.

Returns:

a unique textual representation for the coding.

encode

default Buffer encode(Buffer src,
                      BufferAllocator allocator)

Take a Buffer and encode its contents resulting in a Buffer with the encoded contents. This call increases the Buffer.readerIndex() of the src with the number of bytes available to read Buffer.readableBytes().

Parameters:

src - the Buffer to encode

allocator - the BufferAllocator to use for allocating auxiliary buffers or the returned buffer

Returns:

Buffer the result buffer with the content encoded

encode

Buffer encode(Buffer src,
              int offset,
              int length,
              BufferAllocator allocator)

Take a Buffer and encode its contents resulting in a Buffer with the encoded contents. This call increases the Buffer.readerIndex() of the src with the number of bytes read length.

Parameters:

src - the Buffer to encode

offset - the offset after the current Buffer.readerIndex() to start reading from

length - the total count of bytes to read

allocator - the BufferAllocator to use for allocating auxiliary buffers or the returned buffer

Returns:

Buffer the result buffer with the content encoded

decode

default Buffer decode(Buffer src,
                      BufferAllocator allocator)

Take a Buffer and decode its contents resulting in a Buffer with the decoded content. This call increases the {Buffer.readerIndex() of the src with the number of bytes available to read Buffer.readableBytes().

Parameters:

src - the Buffer to decode

allocator - the BufferAllocator to use for allocating auxiliary buffers or the returned buffer

Returns:

Buffer the result buffer with the content decoded

decode

Buffer decode(Buffer src,
              int offset,
              int length,
              BufferAllocator allocator)

Take a Buffer and decode its contents resulting in a Buffer with the decoded content. This call increases the Buffer.readerIndex() of the src with the number of bytes read length.

Parameters:

src - the Buffer to decode

offset - the offset after the current Buffer.readerIndex() to start reading from

length - the total count of bytes to read

allocator - the BufferAllocator to use for allocating auxiliary buffers or the returned buffer

Returns:

Buffer the result buffer with the content decoded

encode

Publisher<Buffer> encode(Publisher<Buffer> from,
                         BufferAllocator allocator)

Take a Publisher of Buffer and encode its contents resulting in a Publisher of Buffer with the encoded contents.

Parameters:

from - the Publisher buffer to encode

allocator - the BufferAllocator to use for allocating auxiliary buffers or the returned buffer

Returns:

Publisher the result publisher with the buffers encoded

decode

Publisher<Buffer> decode(Publisher<Buffer> from,
                         BufferAllocator allocator)

Take a Publisher of Buffer and encode its contents resulting in a Publisher of Buffer with the decoded contents.

Parameters:

from - the Publisher to decoded

allocator - the BufferAllocator to use for allocating auxiliary buffers or the returned buffer

Returns:

Publisher the result publisher with the buffers decoded