Module ancillary 

Available on crate features io and ancillary only.

Ancillary data (control message) support for connected streams.

Ancillary messages are used to pass out-of-band information such as file descriptors (Unix domain sockets), credentials, or kTLS record types.

Types

• AncillaryBuf: A fixed-size, properly aligned stack buffer for ancillary messages.
• AncillaryBuilder: A builder for constructing ancillary messages into a AncillaryBuf.
• AncillaryIter: An iterator over a buffer of ancillary messages.
• AncillaryRef: A reference to a single ancillary data entry.
• AncillaryData: Trait for types that can be encoded/decoded as ancillary data payloads.
• CodecError: Error type for encoding/decoding operations.

Traits

• AsyncReadAncillary: read data together with ancillary data
• AsyncWriteAncillary: write data together with ancillary data

Functions

• ancillary_space: Helper function to calculate ancillary message size for a type.

Modules

• bytemuck_ext: Extension module for automatic AncillaryData implementation via bytemuck (requires bytemuck feature).

Modules

bytemuck_extbytemuck

Extension module for automatic AncillaryData implementation via bytemuck.

Structs

AncillaryBuf

A fixed-size, stack-allocated buffer for ancillary (control) messages.

AncillaryBuilder

Helper to construct ancillary (control) messages.

AncillaryIter

An iterator for ancillary (control) messages.

AncillaryRef

Reference to an ancillary (control) message.

Enums

CodecError

Error that can occur when encoding or decoding ancillary data.

Traits

AncillaryData

Trait for types that can be encoded and decoded as ancillary data payloads.

AsyncReadAncillary

Trait for asynchronous read with ancillary (control) data. Intended for connected stream sockets (TCP, Unix streams) where no source address is needed.

AsyncReadAncillaryManaged

Trait for asynchronous read with ancillary (control) data that returns managed buffers. Intended for connected stream sockets (TCP, Unix streams) where no source address is needed.

AsyncReadAncillaryMulti

Trait for asynchronous read with ancillary (control) data that returns multiple managed buffers. Intended for connected stream sockets (TCP, Unix streams) where no source address is needed.

AsyncWriteAncillary

Trait for asynchronous write with ancillary (control) data. Intended for connected stream sockets (TCP, Unix streams) where no destination address is needed.

AsyncWriteAncillaryZerocopy

Trait for zerocopy asynchronous write with ancillary (control) data. Intended for connected stream sockets (TCP, Unix streams) where no destination address is needed.

Functions

ancillary_space

Returns the buffer size required to hold one ancillary message carrying a value of type T.