Skip to main content

OpenStreamWriterOptions

Struct OpenStreamWriterOptions 

Source
pub struct OpenStreamWriterOptions {
    pub progress_token: String,
    pub publish_frame: PublishFrame,
    pub content_type: Option<String>,
    pub on_close: Option<OnCloseHook>,
    pub on_abort: Option<OnAbortHook>,
    pub idle_timeout: Option<Duration>,
    pub probe_timeout: Duration,
}
Expand description

Construction options for an OpenStreamWriter.

Fields§

§progress_token: String

The stream id (stringified progressToken).

§publish_frame: PublishFrame

Outbound publisher (same seam as the session).

§content_type: Option<String>

Optional advisory start content type (writer-settable, receiver-ignored).

§on_close: Option<OnCloseHook>

Fired after a terminal close frame is published.

§on_abort: Option<OnAbortHook>

Fired after a terminal abort frame is published.

§idle_timeout: Option<Duration>

Sender-side keepalive idle window (CEP-41 §Timeout and Keepalive). None disables keepalive (e.g. unit tests). When set, the writer arms the window once it starts streaming and probes the peer with ping if no inbound frame arrives within this duration; a missing pong aborts with "Probe timeout", closing a leak where a silently-disconnected client left the writer (and its upstream producer) alive indefinitely.

§probe_timeout: Duration

Time the writer waits for a matching pong after probing before aborting. Ignored when idle_timeout is None.

Implementations§

Source§

impl OpenStreamWriterOptions

Source

pub fn with_keepalive(self, idle: Duration, probe: Duration) -> Self

Enable sender-side keepalive with the given idle/probe windows.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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