Enum wick_packet::Entity

pub enum Entity {
    Invalid,
    System(SystemEntity),
    Test(String),
    Client(String),
    Host(String),
    Operation(String, String),
    Collection(String),
    Reference(String),
}

The entity being referenced across systems or services.

Variants

Invalid

A [SystemEntity] with the name “invalid”. Used only for situations where a default is necessary.

System(SystemEntity)

The [SystemEntity] is used when communicating to or from the internals of another component. Used mostly by library developers.

Test(String)

A [SystemEntity] with the name “test”. Used as the originating entity for tests.

Client(String)

A client entity used for requests.

Host(String)

A Host entity used for entities that serve responses to requests.

Operation(String, String)

A component or anything that can be invoked like a component.

Collection(String)

A collection of components.

Reference(String)

A reference to an instance of an entity.

Implementations

impl Entity

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

Namespace for components local to a collection.

pub fn operation<T: AsRef<str>, U: AsRef<str>>(ns: T, name: U) -> Self

Constructor for [Entity::Component].

pub fn local<T: AsRef<str>>(name: T) -> Self

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

pub fn component_direct<T: AsRef<str>>(name: T) -> Self

👎Deprecated: please use local() instead

Constructor for [Entity::Component] without a namespace, used when the namespace is irrelevant. Caution: this is not portable.

pub fn system<T: AsRef<str>, U: AsRef<str>>(name: T, value: U) -> Self

Constructor for Entity::System.

pub fn test<T: AsRef<str>>(msg: T) -> Self

Constructor for an Entity::Test.

pub fn collection<T: AsRef<str>>(id: T) -> Self

Constructor for an Entity::Collection.

pub fn host<T: AsRef<str>>(id: T) -> Self

Constructor for Entity::Host.

pub fn client<T: AsRef<str>>(id: T) -> Self

Constructor for Entity::Client.

pub fn reference<T: AsRef<str>>(id: T) -> Self

Constructor for Entity::Client.

pub fn url(&self) -> String

The URL of the entity.

pub fn name(&self) -> &str

The name of the entity.

pub fn namespace(&self) -> &str

The namespace for the entity.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy 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<Entity> for Entity

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

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

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

This method 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 StructuralPartialEq for Entity