Struct StreamSpec 

pub struct StreamSpec {
    pub kind: u8,
    pub lane_capacity: usize,
    pub buffer_bytes: usize,
}

Which segment a Streams table uses, and how big its lanes and rings are.

One fleet can hold several independent stream tables. They are not interchangeable: a relay carrying response bodies wants a ring sized to a body, while a control channel carrying short frames is faster with a small one, and a lane is a ceiling on concurrent streams per node. Each names its own kind, and a kind is a fleet-wide identity — every process opening it must pass the same geometry, and the segment’s header refuses a peer that does not. StreamSpec::DEFAULT is what Streams::new opens; its values are the compile-time geometry.

Fields

kind: u8

The Orbit SHM kind, and with it the segment name.

lane_capacity: usize

Streams one fleet node can hold open at once. A power of two, at most 65 536.

buffer_bytes: usize

Bytes each direction holds before its writer waits. A power of two.

Implementations

impl StreamSpec

pub const DEFAULT: Self

pub const fn new(kind: u8, lane_capacity: usize, buffer_bytes: usize) -> Self

pub const fn lane_bytes(&self) -> usize

The segment one node’s streams occupy at most: every slot’s two rings. Memory is backed as it is touched, but this is the ceiling a deployment is choosing when it picks a lane and a ring.

Trait Implementations

impl Clone for StreamSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamSpec

impl Debug for StreamSpec

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

Formats the value using the given formatter.

impl Default for StreamSpec

fn default() -> Self

Returns the “default value” for a type.

impl Eq for StreamSpec

impl Hash for StreamSpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StreamSpec

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StreamSpec