Struct UCXLAddress

pub struct UCXLAddress {
    pub agent: String,
    pub role: Option<String>,
    pub project: String,
    pub task: String,
    pub temporal: TemporalAxis,
    pub path: String,
}

Represents a parsed UCXL address.

What: Holds the components extracted from a UCXL URI – the agent, an optional role, the project identifier, task name, temporal axis, and the resource path within the project.

How: The struct is constructed via the FromStr implementation which validates the scheme, splits the address into its constituent parts and populates the fields. The Display implementation performs the inverse operation.

Why: UCXL addresses are the primary routing mechanism inside CHORUS. Encapsulating them in a dedicated type provides type‑safety and makes it easy to work with address components in the rest of the codebase.

Fields

agent: String

The identifier of the agent (e.g., a user or system component).

role: Option<String>

Optional role associated with the agent (e.g., “admin”).

project: String

The project namespace this address belongs to.

task: String

The specific task within the project.

temporal: TemporalAxis

Temporal axis indicating present, past or future.

path: String

Path to the resource relative to the project root.

Trait Implementations

impl Clone for UCXLAddress

fn clone(&self) -> UCXLAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UCXLAddress

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

Formats the value using the given formatter.

impl Display for UCXLAddress

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

Serialises the address back to its canonical string form.

What: Constructs a ucxl:// URI including optional role and path.

How: Conditionally inserts the role component, then formats the project, task, temporal token and optional path using standard write! semantics.

Why: Needed when emitting addresses (e.g., logging events or generating links) so that external tools can consume them.

impl FromStr for UCXLAddress

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

Parses a full UCXL address string into a UCXLAddress value.

What: Validates the scheme (ucxl://), extracts the agent, optional role, project, task, temporal axis and the trailing resource path.

How: The implementation performs a series of split operations, handling optional components and converting the temporal token via TemporalAxis::from_str. Errors are surfaced as descriptive strings.

Why: Centralises address parsing logic, ensuring that all parts of the system interpret UCXL URIs consistently.

type Err = String

The associated error which can be returned from parsing.

impl PartialEq for UCXLAddress

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

impl StructuralPartialEq for UCXLAddress