Struct OpenStreamConfig 

#[non_exhaustive]
pub struct OpenStreamConfig {
    pub enabled: bool,
    pub max_concurrent_streams: usize,
    pub max_buffered_chunks_per_stream: usize,
    pub max_buffered_bytes_per_stream: usize,
    pub idle_timeout_ms: u64,
    pub probe_timeout_ms: u64,
    pub close_grace_period_ms: u64,
    pub max_total_timeout_ms: Option<u64>,
}

CEP-41 open-stream configuration shared by both transports.

Bundles the capability gate plus the reader buffering/keepalive knobs. Attached to NostrServerTransportConfig and NostrClientTransportConfig via their with_open_stream builders.

Disabled by default (opt-in): open-stream is neither advertised nor activated until enabled (matching the TS SDK’s default). Opt in with OpenStreamConfig::enabled or with_enabled(true). Once on, it is safe for non-CEP-41 peers — the server activates only for advertising clients, and a writer is injected only when a request carries a progressToken.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Master gate, false by default. When false the capability is neither advertised nor activated, and the server does not learn a client’s flag.

max_concurrent_streams: usize

Upper bound on concurrently active streams (per peer/registry).

max_buffered_chunks_per_stream: usize

Upper bound on buffered + queued chunks held for a single stream.

max_buffered_bytes_per_stream: usize

Upper bound on buffered + queued payload bytes held for a single stream.

idle_timeout_ms: u64

Idle interval after which a reader probes the peer with a ping (ms).

probe_timeout_ms: u64

Time a reader waits for a pong after probing before aborting (ms).

close_grace_period_ms: u64

Grace period after a close with unresolved gaps before aborting (ms).

max_total_timeout_ms: Option<u64>

Optional hard cap on total stream lifetime (ms).

None (the default) means no lifetime cap. When set, only call_tool_stream reads it (the registry and keepalive sweep never do); it is not the CEP-22 DEFAULT_OVERSIZED_MAX_TOTAL_TIMEOUT.

Implementations

impl OpenStreamConfig

pub fn enabled() -> Self

An explicitly enabled config with all other knobs at their defaults.

pub fn with_enabled(self, enabled: bool) -> Self

Enable or disable open-stream support.

pub fn with_max_concurrent_streams(self, max: usize) -> Self

Set the upper bound on concurrently active streams.

pub fn with_max_buffered_chunks_per_stream(self, max: usize) -> Self

Set the upper bound on buffered + queued chunks per stream.

pub fn with_max_buffered_bytes_per_stream(self, max: usize) -> Self

Set the upper bound on buffered + queued payload bytes per stream.

pub fn with_idle_timeout_ms(self, ms: u64) -> Self

Set the idle interval before a reader probes with a ping (ms).

pub fn with_probe_timeout_ms(self, ms: u64) -> Self

Set the time a reader waits for a pong before aborting (ms).

pub fn with_close_grace_period_ms(self, ms: u64) -> Self

Set the close grace period before aborting on unresolved gaps (ms).

pub fn with_max_total_timeout_ms(self, ms: Option<u64>) -> Self

Set the optional hard cap on total stream lifetime (ms).

Trait Implementations

impl Clone for OpenStreamConfig

fn clone(&self) -> OpenStreamConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenStreamConfig

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

Formats the value using the given formatter.

impl Default for OpenStreamConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<&OpenStreamConfig> for OpenStreamRegistryPolicy

fn from(config: &OpenStreamConfig) -> Self

Project the registry-relevant knobs of an OpenStreamConfig into an OpenStreamRegistryPolicy (the reader admission/buffering policy).