Struct OversizedTransferConfig 

#[non_exhaustive]
pub struct OversizedTransferConfig {
    pub enabled: bool,
    pub threshold: usize,
    pub chunk_size: usize,
    pub max_transfer_bytes: u64,
    pub max_transfer_chunks: u64,
    pub max_concurrent_transfers: usize,
    pub transfer_timeout_ms: u64,
    pub max_out_of_order_window: u64,
    pub max_out_of_order_chunks: usize,
    pub accept_timeout_ms: u64,
}

CEP-22 oversized-transfer configuration shared by both transports.

Bundles the capability gate plus the sender/receiver tuning knobs so the nine numeric defaults don’t clutter the flat transport configs. Attached to NostrServerTransportConfig and NostrClientTransportConfig via their with_oversized_transfer / with_oversized_enabled builders.

Enabled by default (TS parity) — opt out with with_enabled(false) or the transports’ with_oversized_enabled(false) builders. The negotiation gates make the default safe for non-oversized peers: the server activates only for clients that advertise support, and the client fragments only requests carrying a progressToken — a disabled peer just sees one extra support_oversized_transfer tag.

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, true by default. When false the capability is neither advertised nor activated, and the server does not learn a client’s flag.

threshold: usize

Serialized byte length at or above which the sender switches to oversized transfer.

chunk_size: usize

Per-chunk data size (bytes).

max_transfer_bytes: u64

Upper bound on the total reassembled payload a receiver will accept (bytes).

max_transfer_chunks: u64

Upper bound on the number of chunks a receiver will accept.

max_concurrent_transfers: usize

Upper bound on concurrently active receiver-side transfers.

transfer_timeout_ms: u64

Hard timeout for an in-flight transfer (milliseconds), measured from admission. 0 disables the receiver-side watchdog.

max_out_of_order_window: u64

Maximum forward gap between the next expected chunk and an out-of-order chunk that will still be buffered.

max_out_of_order_chunks: usize

Maximum number of buffered out-of-order chunks.

accept_timeout_ms: u64

Timeout a sender waits for an accept frame before giving up (milliseconds).

Used by the client transport only. The client is the sole party that sends a start frame with an accept handshake and then waits for the accept. On the server transport this field is inert: a server is always the receiver of the handshake — it emits the accept, it never waits for one — so its value is never read server-side.

Implementations

impl OversizedTransferConfig

pub fn enabled() -> Self

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

Redundant since enabled defaulted to true (kept for API stability); equivalent to OversizedTransferConfig::default.

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

Enable or disable oversized transfer.

pub fn with_threshold(self, threshold: usize) -> Self

Set the serialized-byte threshold at which the sender fragments.

pub fn with_chunk_size(self, chunk_size: usize) -> Self

Set the per-chunk data size (bytes).

pub fn with_max_transfer_bytes(self, max: u64) -> Self

Set the upper bound on the total reassembled payload (bytes).

pub fn with_max_transfer_chunks(self, max: u64) -> Self

Set the upper bound on the number of chunks a receiver will accept.

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

Set the upper bound on concurrently active receiver-side transfers.

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

Set the hard per-transfer timeout (milliseconds).

pub fn with_max_out_of_order_window(self, window: u64) -> Self

Set the maximum forward gap for buffering out-of-order chunks.

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

Set the maximum number of buffered out-of-order chunks.

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

Set the sender’s accept-frame wait timeout (milliseconds).

Trait Implementations

impl Clone for OversizedTransferConfig

fn clone(&self) -> OversizedTransferConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OversizedTransferConfig

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

Formats the value using the given formatter.

impl Default for OversizedTransferConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<&OversizedTransferConfig> for TransferPolicy

fn from(config: &OversizedTransferConfig) -> Self

Project the receiver-relevant knobs of an OversizedTransferConfig into a TransferPolicy (the receiver admission policy).