Struct StreamName 

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

The name of a stream: what goes into the URL, and what a person reads in the relay’s listing.

One to MAX_NAME_LEN characters, lowercase ASCII letters, digits, -, _ and ., starting with a letter or a digit. Narrow on purpose: a name travels in a URL path, in a log line and in a file listing, and each of those has its own idea of what is special. Widening the set later breaks nobody; narrowing it would.

The relay sees names - they are not sealed. A name that says more than it should (bank-passwords) says it to whoever runs the relay.

use efema_proto::StreamName;

assert!("notes".parse::<StreamName>().is_ok());
assert!("vault.2026-10".parse::<StreamName>().is_ok());
assert!("Notes".parse::<StreamName>().is_err());
assert!("-notes".parse::<StreamName>().is_err());
assert!("a/b".parse::<StreamName>().is_err());

Implementations

impl StreamName

pub fn new(name: impl Into<String>) -> Result<Self, InvalidName>

Checks name and wraps it.

Errors

The first reason name is not a valid stream name.

pub fn as_str(&self) -> &str

The name as text.

Trait Implementations

impl AsRef<str> for StreamName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for StreamName

fn clone(&self) -> Self

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<'b, C> Decode<'b, C> for StreamName

fn decode(d: &mut Decoder<'b>, _: &mut C) -> Result<Self, DecodeError>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl Display for StreamName

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

Formats the value using the given formatter.

impl<C> Encode<C> for StreamName

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), EncodeError<W::Error>>

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl Eq for StreamName

impl FromStr for StreamName

type Err = InvalidName

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for StreamName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StreamName

fn partial_cmp(&self, other: &Self) -> 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