Skip to main content

PubOptions

Struct PubOptions 

Source
pub struct PubOptions {
    pub write_buffer_size: usize,
    pub write_buffer_linger: Option<Duration>,
    /* private fields */
}

Fields§

§write_buffer_size: usize

The size of the write buffer in bytes.

§write_buffer_linger: Option<Duration>

The linger duration for the write buffer (how long to wait before flushing).

Implementations§

Source§

impl PubOptions

Source

pub fn new(profile: Profile) -> Self

Creates new options based on the given profile.

Source§

impl PubOptions

Source

pub fn low_latency() -> Self

Creates options optimized for low latency.

Source

pub fn high_throughput() -> Self

Creates options optimized for high throughput.

Source

pub fn balanced() -> Self

Creates options optimized for a balanced trade-off between latency and throughput.

Source§

impl PubOptions

Source

pub fn with_max_clients(self, max_clients: usize) -> Self

Sets the maximum number of concurrent clients.

Source

pub fn with_high_water_mark(self, hwm: usize) -> Self

Sets the high-water mark per session. This is the amount of messages that can be buffered per session before messages start being dropped.

Source

pub fn with_min_compress_size(self, min_compress_size: usize) -> Self

Sets the minimum payload size in bytes for compression to be used. If the payload is smaller than this threshold, it will not be compressed.

Source

pub fn with_write_buffer_size(self, size: usize) -> Self

Sets the size (max capacity) of the write buffer in bytes. When the buffer is full, it will be flushed to the underlying transport.

Default: 8KiB

Source

pub fn with_write_buffer_linger(self, duration: Option<Duration>) -> Self

Sets the linger duration for the write buffer. If None, the write buffer will only be flushed when the buffer is full.

Default: 100µs

Trait Implementations§

Source§

impl Debug for PubOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PubOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> SpanExt<T> for T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more