Struct ProducerConfig

pub struct ProducerConfig {
    pub producer_name: Option<String>,
    pub shm_size_kb: Option<u32>,
    pub page_size_kb: Option<u32>,
}

Fields

producer_name: Option<String>

Identifies the producer for which this config is for.

shm_size_kb: Option<u32>

Specifies the preferred size of the shared memory buffer. If the size is larger than the max size, the max will be used. If it is smaller than the page size or doesn’t fit pages evenly into it, it will fall back to the size specified by the producer or finally the default shared memory size.

page_size_kb: Option<u32>

Specifies the preferred size of each page in the shared memory buffer. Must be an integer multiple of 4K.

Implementations

impl ProducerConfig

pub fn producer_name(&self) -> &str

Returns the value of producer_name, or the default value if producer_name is unset.

pub fn shm_size_kb(&self) -> u32

Returns the value of shm_size_kb, or the default value if shm_size_kb is unset.

pub fn page_size_kb(&self) -> u32

Returns the value of page_size_kb, or the default value if page_size_kb is unset.

Trait Implementations

impl Clone for ProducerConfig

fn clone(&self) -> ProducerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProducerConfig

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

Formats the value using the given formatter.

impl Default for ProducerConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProducerConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProducerConfig

fn eq(&self, other: &ProducerConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProducerConfig