Enum Entity

#[non_exhaustive]
pub enum Entity {
    Invalid,
    Test(String),
    Server(String),
    Operation(String, String),
    Component(String),
}

The entity being referenced across systems or services.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Invalid

An invalid entity. Used only for situations where a default is necessary.

Test(String)

A “test” entity. Used as the originating entity for tests.

Server(String)

A server or host entity (i.e. for requests).

Operation(String, String)

An operation or anything that can be invoked like an operation.

Component(String)

A component that hosts a collection of operations.

Implementations

impl Entity

pub const LOCAL: &'static str = "__local__"

Namespace for components local to a collection.

pub fn operation<T: Into<String>, U: Into<String>>(ns: T, name: U) -> Self

Constructor for Entity::Component.

pub fn local<T: Into<String>>(name: T) -> Self

Constructor for Entity::Component on the local namespace, used when the namespace is irrelevant. Caution: this is not portable.

pub fn test<T: Into<String>>(msg: T) -> Self

Constructor for an Entity::Test.

pub fn component<T: Into<String>>(id: T) -> Self

Constructor for an Entity::Component.

pub fn server<T: Into<String>>(id: T) -> Self

Constructor for Entity::Server.

pub fn url(&self) -> String

The URL of the entity.

pub fn operation_id(&self) -> &str

The name of the entity.

pub fn set_operation<T: Into<String>>(&mut self, id: T)

pub fn component_id(&self) -> &str

The id of the component entity.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Entity

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Entity

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

Formats the value using the given formatter.

impl FromStr for Entity

type Err = ParseError

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Entity

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Entity