Struct StreamId 

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

An append-only event stream identifier.

Streams are named with a category prefix so routing and partitioning are explicit (e.g. process/{tenant_id}/{process_id}, partner/{partner_id}).

Implementations

impl StreamId

pub fn new(id: impl Into<Box<str>>) -> Self

Construct a stream identifier from any string-like value.

Panics

Panics if id is empty or contains a NUL byte (\0). Use this constructor only for compile-time literals where the value is statically known to be valid. For runtime/externally-supplied strings use StreamId::try_new or the typed constructors (StreamId::for_process, StreamId::for_partner).

pub fn try_new(id: impl Into<Box<str>>) -> Result<Self, EngineError>

Fallible constructor — returns Err instead of panicking.

Prefer this over StreamId::new whenever the input string originates from user input, network data, or storage. The typed constructors (StreamId::for_process, StreamId::for_partner) call this internally.

Errors

Returns crate::error::EngineError::InvalidStreamId if id is empty or contains a NUL byte.

pub fn for_process(tenant_id: TenantId, process_id: &ProcessId) -> Self

Canonical stream for a process instance: process/{tenant_id}/{process_id}.

The tenant discriminator prevents cross-tenant event leakage when list_streams is called with a tenant-scoped prefix (process/{tenant_id}/).

pub fn for_partner(partner_id: &str) -> Result<Self, EngineError>

Canonical stream for a market partner: partner/{partner_id}.

Errors

Returns an error if partner_id contains / or a NUL byte, which would escape the partner/ prefix used for range scans.

pub fn as_str(&self) -> &str

The raw stream identifier string.

Trait Implementations

impl Clone for StreamId

fn clone(&self) -> StreamId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StreamId

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

Formats the value using the given formatter.

impl Eq for StreamId

impl Hash for StreamId

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 StreamId

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StreamId

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamId

impl TryFrom<&str> for StreamId

type Error = EngineError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Box<str>> for StreamId

type Error = EngineError

The type returned in the event of a conversion error.

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for StreamId

type Error = EngineError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.