Skip to main content

StreamConfig

tokio_process_tools

Struct StreamConfig

pub struct StreamConfig<D = BestEffortDelivery, R = NoReplay>where
    D: Delivery,
    R: Replay,{
    pub read_chunk_size: NumBytes,
    pub max_buffered_chunks: usize,
    pub delivery: D,
    pub replay: R,
}

Expand description

Shared output stream configuration for all stream backends.

Backend selection controls whether a stream has one active owner or can fan out to multiple consumers. This configuration controls delivery, replay, and buffering for whichever backend is selected.

Fields§

§read_chunk_size: NumBytes

The size of an individual chunk read from the underlying process stream.

Must be greater than zero. The default is crate::DEFAULT_READ_CHUNK_SIZE.

§max_buffered_chunks: usize

The number of chunks held by the underlying async channel.

Must be greater than zero. The default is crate::DEFAULT_MAX_BUFFERED_CHUNKS. With DeliveryGuarantee::ReliableForActiveSubscribers, it is the maximum unread chunk lag an active subscriber can have before reading waits.

§delivery: D

How slow active subscribers affect reading from the underlying stream.

§replay: R

Whether and how replay history is retained for subscribers that attach after output arrives.

Implementations§

impl StreamConfig<BestEffortDelivery, NoReplay>

pub fn builder() -> StreamConfigBuilder

Starts building an output stream configuration.

impl<D, R> StreamConfig<D, R>
where D: Delivery, R: Replay,

pub fn delivery_guarantee(self) -> DeliveryGuarantee

Returns the runtime delivery guarantee represented by this configuration.

pub fn replay_retention(self) -> Option<ReplayRetention>

Returns the replay retention represented by this configuration.

pub fn replay_enabled(self) -> bool

Returns whether this configuration enables replay-specific APIs.

impl<D> StreamConfig<D, ReplayEnabled>
where D: Delivery,

pub fn with_replay_retention(self, replay_retention: ReplayRetention) -> Self

Returns this replay-enabled configuration with custom replay retention.

Trait Implementations§

impl<D, R> Clone for StreamConfig<D, R>
where D: Delivery + Clone, R: Replay + Clone,

fn clone(&self) -> StreamConfig<D, R>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<D, R> Debug for StreamConfig<D, R>
where D: Delivery + Debug, R: Replay + Debug,

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

Formats the value using the given formatter. Read more

impl<D, R> PartialEq for StreamConfig<D, R>
where D: Delivery + PartialEq, R: Replay + PartialEq,

fn eq(&self, other: &StreamConfig<D, R>) -> bool

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

1.0.0 · Source§

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<D, R> Copy for StreamConfig<D, R>
where D: Delivery + Copy, R: Replay + Copy,

impl<D, R> Eq for StreamConfig<D, R>
where D: Delivery + Eq, R: Replay + Eq,

impl<D, R> StructuralPartialEq for StreamConfig<D, R>
where D: Delivery, R: Replay,

Auto Trait Implementations§

impl<D, R> Freeze for StreamConfig<D, R>
where D: Freeze, R: Freeze,

impl<D, R> RefUnwindSafe for StreamConfig<D, R>
where D: RefUnwindSafe, R: RefUnwindSafe,

impl<D, R> Send for StreamConfig<D, R>

impl<D, R> Sync for StreamConfig<D, R>

impl<D, R> Unpin for StreamConfig<D, R>
where D: Unpin, R: Unpin,

impl<D, R> UnsafeUnpin for StreamConfig<D, R>
where D: UnsafeUnpin, R: UnsafeUnpin,

impl<D, R> UnwindSafe for StreamConfig<D, R>
where D: UnwindSafe, R: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Sink for T
where T: Send + 'static,