Struct fizyr_rpc::StreamConfig

#[non_exhaustive]
pub struct StreamConfig {
    pub max_body_len_read: u32,
    pub max_body_len_write: u32,
    pub endian: Endian,
}

Configuration for a byte-stream transport.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_body_len_read: u32

The maximum body size for incoming messages.

If a message arrives with a larger body size, an error is returned. For stream sockets, that also means the stream is unusable because there is unread data left in the stream.

max_body_len_write: u32

The maximum body size for outgoing messages.

If a message is given for sending with a larger body than this size, the message is discarded and an error is returned. Stream sockets remain usable since the message header will not be sent either.

endian: Endian

The endianness to use when encoding/decoding header fields.

The encoding and serialization of message bodies is up to the application code, and it not affected by this configuration parameter.

Trait Implementations

impl Clone for StreamConfig

fn clone(&self) -> StreamConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StreamConfig

fn default() -> Self

Returns the “default value” for a type.