Struct TheaterId

pub struct TheaterId(Uuid);

TheaterId

A unique identifier for entities within the Theater system, including actors, channels, and resources.

Purpose

TheaterId provides a type-safe way to identify and reference entities within the Theater system. It helps prevent confusion between different types of IDs and enables strong type checking at compile time.

Implementation Notes

Internally, TheaterId is implemented using UUIDs (Universally Unique Identifiers) to ensure uniqueness across distributed systems without requiring central coordination.

Tuple Fields

0: Uuid

Implementations

impl TheaterId

pub fn generate() -> Self

Generates a new random TheaterId.

Purpose

This method creates a new, globally unique identifier that can be used to identify an actor, channel, or other entity in the Theater system.

Returns

A new TheaterId instance with a random UUID.

Example

use theater::id::TheaterId;

let id = TheaterId::generate();

Implementation Notes

This method uses the UUID v4 algorithm, which generates IDs using random numbers. This ensures that IDs are unique across different machines without coordination.

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

Parses a TheaterId from a string.

Parameters

• s - The string to parse

Returns

• Ok(TheaterId) - The successfully parsed TheaterId
• Err(uuid::Error) - An error occurred during parsing

Example

use theater::id::TheaterId;

let id_result = TheaterId::parse("550e8400-e29b-41d4-a716-446655440000");
assert!(id_result.is_ok());

let invalid_result = TheaterId::parse("not-a-valid-uuid");
assert!(invalid_result.is_err());

pub fn as_uuid(&self) -> &Uuid

Gets the underlying UUID.

Returns

A reference to the underlying Uuid.

Example

use theater::id::TheaterId;

let id = TheaterId::generate();
let uuid = id.as_uuid();

Purpose

This method allows access to the underlying UUID, which can be useful for interoperating with other systems or libraries that work with UUIDs directly.

Trait Implementations

impl Clone for TheaterId

fn clone(&self) -> TheaterId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TheaterId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TheaterId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TheaterId

Implementation of the Display trait for TheaterId.

This allows converting a TheaterId to a string using the standard Display trait, which enables using it with string formatting macros like format!, println!, etc.

Example

use theater::id::TheaterId;

let id = TheaterId::generate();
let id_string = format!("{}", id);  // Converts to hyphenated UUID string
println!("Actor ID: {}", id);      // Prints the ID in a readable format

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

Formats the value using the given formatter.

impl FromStr for TheaterId

Implementation of the FromStr trait for TheaterId.

This allows parsing a TheaterId from a string using the standard FromStr trait, which enables using the parse method on strings and the ? operator for error handling.

Example

use theater::id::TheaterId;
use std::str::FromStr;

let id = TheaterId::from_str("550e8400-e29b-41d4-a716-446655440000").unwrap();

type Err = Error

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 TheaterId

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 TheaterId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TheaterId

impl StructuralPartialEq for TheaterId