Struct AgentPath 

pub struct AgentPath { /* private fields */ }

A tree-style path identifying an agent in the agent hierarchy.

Format

Path segments are separated by /. The root agent is always root. Child agents have paths like root/searcher or root/analyzer.

Examples

use agent_works::multi_agent::AgentPath;

let root = AgentPath::root();
assert!(root.is_root());
assert_eq!(root.depth(), 0);
assert_eq!(root.to_string(), "root");

let child = root.join("searcher");
assert!(!child.is_root());
assert_eq!(child.depth(), 1);
assert_eq!(child.to_string(), "root/searcher");

let parsed = "root/searcher".parse::<AgentPath>().unwrap();
assert_eq!(parsed, child);

Implementations

impl AgentPath

pub fn root() -> Self

Create the root agent path.

pub fn join(&self, name: &str) -> Self

Create a child path by appending a segment.

Examples

use agent_works::multi_agent::AgentPath;

let root = AgentPath::root();
let searcher = root.join("searcher");
assert_eq!(searcher.to_string(), "root/searcher");

pub fn parse(path: &str) -> Option<Self>

Parse from a string like "root/searcher/worker-1".

Returns None if the string is empty, contains an empty segment, or does not start with "root".

pub fn is_root(&self) -> bool

Returns true if this is the root agent.

pub fn depth(&self) -> usize

Returns the depth from root.

Root has depth 0, root/searcher has depth 1, root/searcher/worker-1 has depth 2.

pub fn name(&self) -> &str

Returns the name of this agent (the last segment).

Examples

use agent_works::multi_agent::AgentPath;

let path = AgentPath::root().join("searcher");
assert_eq!(path.name(), "searcher");
assert_eq!(AgentPath::root().name(), "root");

pub fn parent(&self) -> Option<Self>

Returns the parent path, or None if this is the root.

Examples

use agent_works::multi_agent::AgentPath;

let child = AgentPath::root().join("searcher");
assert_eq!(child.parent(), Some(AgentPath::root()));
assert_eq!(AgentPath::root().parent(), None);

pub fn segments(&self) -> &[String]

Returns the segments of this path.

Trait Implementations

impl Clone for AgentPath

fn clone(&self) -> AgentPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentPath

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for AgentPath

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

Formats the value using the given formatter.

impl Eq for AgentPath

impl FromStr for AgentPath

type Err = String

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 AgentPath

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 AgentPath

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AgentPath

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AgentPath