Struct StreamName 

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

Value Object: StreamName

Represents the name of an event stream in the event store. Streams are logical groupings of events, typically by entity or aggregate.

Domain Rules:

• Cannot be empty
• Must be between 1 and 256 characters
• Must follow naming convention: alphanumeric with hyphens/underscores/colons
• Case-sensitive
• Immutable once created

Common patterns:

• entity-type:entity-id (e.g., “user:123”, “order:abc-456”)
• aggregate-type-aggregate-id (e.g., “user-123”, “order-abc-456”)

This is a Value Object:

• Defined by its value, not identity
• Immutable
• Self-validating
• Compared by value equality

Implementations

impl StreamName

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

Create a new StreamName with validation

Errors

Returns error if:

• Name is empty
• Name is longer than 256 characters
• Name contains invalid characters

Examples

use allsource_core::domain::value_objects::StreamName;

let stream = StreamName::new("user:123".to_string()).unwrap();
assert_eq!(stream.as_str(), "user:123");

pub fn for_entity(entity_type: &str, entity_id: &str) -> Result<Self>

Create a StreamName from entity type and entity ID

Examples

use allsource_core::domain::value_objects::StreamName;

let stream = StreamName::for_entity("user", "123").unwrap();
assert_eq!(stream.as_str(), "user:123");

pub fn as_str(&self) -> &str

Get the string value

pub fn into_inner(self) -> String

Get the inner String (consumes self)

pub fn entity_type(&self) -> Option<&str>

Extract entity type if stream follows “type:id” pattern

Examples

use allsource_core::domain::value_objects::StreamName;

let stream = StreamName::new("user:123".to_string()).unwrap();
assert_eq!(stream.entity_type(), Some("user"));

let stream = StreamName::new("simple-stream".to_string()).unwrap();
assert_eq!(stream.entity_type(), None);

pub fn entity_id(&self) -> Option<&str>

Extract entity ID if stream follows “type:id” pattern

Examples

use allsource_core::domain::value_objects::StreamName;

let stream = StreamName::new("user:123".to_string()).unwrap();
assert_eq!(stream.entity_id(), Some("123"));

let stream = StreamName::new("simple-stream".to_string()).unwrap();
assert_eq!(stream.entity_id(), None);

pub fn is_entity_type(&self, entity_type: &str) -> bool

Check if this stream is for a specific entity type

Examples

use allsource_core::domain::value_objects::StreamName;

let stream = StreamName::new("user:123".to_string()).unwrap();
assert!(stream.is_entity_type("user"));
assert!(!stream.is_entity_type("order"));

pub fn starts_with(&self, prefix: &str) -> bool

Check if this stream name starts with a prefix

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) -> 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<'de> Deserialize<'de> for StreamName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StreamName

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

Formats the value using the given formatter.

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for StreamName

type Error = AllSourceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for StreamName

type Error = AllSourceError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl Eq for StreamName

impl StructuralPartialEq for StreamName