Skip to main content

ConnectOptions

Struct ConnectOptions 

Source
pub struct ConnectOptions {
    pub url: String,
    pub headers: HeaderMap,
    pub handshake_provider: Option<HandshakeProvider>,
    pub metadata: Metadata,
    pub reconnect: ReconnectPolicy,
    pub handshake_timeout: Duration,
    pub connect_timeout: Option<Duration>,
    pub initial_messages: InitialMessages,
    pub event_history: EventOptions,
    pub routing: ResponseRouting,
    pub diagnostics: Option<HandshakeDiagnosticOptions>,
}
Expand description

URL, handshake, reconnect, and receive settings for a WebSocket session.

Fields§

§url: String

Target WebSocket URL with a host and ws or wss scheme.

§headers: HeaderMap

Static HTTP headers added to each handshake; provider values may override duplicates.

§handshake_provider: Option<HandshakeProvider>

Provider for dynamic handshake headers and context; None uses static settings only.

§metadata: Metadata

Application metadata for local observation and correlation; never sent automatically.

§reconnect: ReconnectPolicy

Retry policy after connection failure or termination; bounded exponential backoff by default.

§handshake_timeout: Duration

Per-attempt handshake deadline, including context preparation and network setup (10 s default).

§connect_timeout: Option<Duration>

Overall deadline from session start to the first successful connection (30 s default). Retries and waits count toward it; None removes this additional limit.

§initial_messages: InitialMessages

Whether to create a buffered initial message inbox when the session starts.

§event_history: EventOptions

Count and byte capacity of connection-event history for later replay.

§routing: ResponseRouting

Strategy for recognizing and completing pending requests from business messages.

§diagnostics: Option<HandshakeDiagnosticOptions>

Handshake diagnostic collection and redaction; None disables optional diagnostics.

Implementations§

Source§

impl ConnectOptions

Source

pub fn new(url: impl Into<String>) -> Self

Creates options for a URL with safe defaults.

Source

pub fn validate(&self) -> Result<()>

Validates URL, limits, routing, and nested option values.

Trait Implementations§

Source§

impl Clone for ConnectOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectOptions

Source§

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

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

impl From<&str> for ConnectOptions

Source§

fn from(url: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for ConnectOptions

Source§

fn from(url: String) -> Self

Converts to this type from the input type.

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> CloneToUninit for T
where T: Clone,

Source§

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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