Struct StreamName 

pub struct StreamName(/* private fields */);

The user-facing name of a stream within a branch (UTF-8, non-empty, no NUL bytes, at most StreamName::MAX_BYTES). The engine maps it to a stable compact StreamId internally.

Implementations

impl StreamName

pub const MAX_BYTES: usize = 1024

Maximum length of a stream name, in bytes.

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

Validates and constructs a stream name, rejecting empty, oversized, or NUL-containing input.

pub fn as_str(&self) -> &str

The name as a string slice.

Trait Implementations

impl Clone for StreamName

fn clone(&self) -> StreamName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamName

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

Formats the value using the given formatter.

impl Eq for StreamName

impl Hash for StreamName

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 Ord for StreamName

fn cmp(&self, other: &StreamName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StreamName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StreamName

fn partial_cmp(&self, other: &StreamName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for StreamName

impl TryFrom<&str> for StreamName

type Error = SalamanderError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.