Struct svc_agent::AgentId

pub struct AgentId { /* fields omitted */ }

Agent identifier.

It consists of a string label and AccountId and must be unique.

Multiple agents may use the same AccountId, e.g. multiple instances of the same service or multiple devices or browser tabs of an end user, but the label must be different across them. An agent identifier has to be unique, otherwise it gets disconnected by the broker. You can safely use the same label if AccountId is different.

Implementations

impl AgentId

pub fn new(label: &str, account_id: AccountId) -> Self

Builds an AgentId.

Arguments

• label – a unique string to identify the particular agent. For example the name of a service instance or a user device.

• account_id – the account identifier of an agent.

Example

let agent_id1 = AgentId::new("instance01", AccountId::new("service_name", "svc.example.org"));
let agent_id2 = AgentId::new("web", AccountId::new("user_name", "usr.example.org"));

pub fn label(&self) -> &str

Trait Implementations

impl Addressable for AgentId

fn as_agent_id(&self) -> &Self

Returns the AgentId reference of the addressable object.

impl Authenticable for AgentId

fn as_account_id(&self) -> &AccountId

impl Clone for AgentId

fn clone(&self) -> AgentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AgentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentId

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

Deserialize this value from the given Serde deserializer.

impl Display for AgentId

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

Formats AgentId as LABEL.ACCOUNT_ID.

Example

let agent_id = AgentId::new("instance01", AccountId::new("service_name", "svc.example.org"));
format!("{}", agent_id); // => "instance01.service_name.svc.example.org"

impl FromStr for AgentId

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

Parses AgentId from LABEL.ACCOUNT_ID format.

Example

let agent_id = AgentId::from_str("instance01.service_name.svc.example.org"));

type Err = Error

The associated error which can be returned from parsing.

impl Hash for AgentId

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

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

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

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

This method tests for !=.

impl Serialize for AgentId

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 AgentId

impl StructuralEq for AgentId

impl StructuralPartialEq for AgentId