Struct kompact::prelude::NamedPath

pub struct NamedPath { /* fields omitted */ }

A named actor path identifies a service, rather than a concrete actor instance

Named paths must be registered to a particular actor, and their registration can be changed over time, as actors fail and are replaced, for example.

Named paths may be described hierarchically, similar to URLs.

A named path may look something like "tcp://127.0.0.1:8080/my-actor-group/my-actor", for example.

Methods

impl NamedPath

pub fn new(
    protocol: Transport,
    address: IpAddr,
    port: u16,
    path: Vec<String>
) -> NamedPath

Construct a new named path from parts

Make sure that none of the elements of the path vector contain slashes (i.e., /), as those will be the path separators for the individual elements later.

pub fn with_socket(
    protocol: Transport,
    socket: SocketAddr,
    path: Vec<String>
) -> NamedPath

Construct a new named path from a socket and vector of path elements

Make sure that none of the elements of the path vector contain slashes (i.e., /), as those will be the path separators for the individual elements later.

pub fn with_system(system: SystemPath, path: Vec<String>) -> NamedPath

Construct a new named path from a system path and vector of path elements

Make sure that none of the elements of the path vector contain slashes (i.e., /), as those will be the path separators for the individual elements later.

pub fn path_ref(&self) -> &Vec<String>

Returns a reference to the path vector

pub fn clone_path(&self) -> Vec<String>

Returns a copy to the path vector

pub fn system_mut(&mut self) -> &mut SystemPath

Returns a mutable reference to this path's system path part

Trait Implementations

impl Clone for NamedPath

fn clone(&self) -> NamedPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NamedPath

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

Formats the value using the given formatter.

impl Eq for NamedPath

impl From<NamedPath> for ActorPath

fn from(p: NamedPath) -> ActorPath

Performs the conversion.

impl FromStr for NamedPath

type Err = PathParseError

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 NamedPath

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for NamedPath

fn cmp(&self, other: &NamedPath) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<NamedPath> for NamedPath

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<NamedPath> for NamedPath

fn partial_cmp(&self, other: &NamedPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &NamedPath) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &NamedPath) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &NamedPath) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &NamedPath) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for NamedPath

impl StructuralPartialEq for NamedPath

impl SystemField for NamedPath

fn system(&self) -> &SystemPath

Returns a reference to the system path

fn protocol(&self) -> Transport

Returns the transport protocol used in the system path

fn address(&self) -> &IpAddr

Returns the address used in the system path

fn port(&self) -> u16

Returns the port used in the system path

impl TryFrom<String> for NamedPath

type Error = PathParseError

The type returned in the event of a conversion error.

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

Performs the conversion.