Struct EntityUID

pub struct EntityUID { /* private fields */ }

Unique ID for an entity. These represent entities in the AST.

Implementations

impl EntityUID

pub fn with_eid_and_type(typename: &str, eid: &str) -> Result<Self, ParseErrors>

Create an EntityUID with the given (unqualified) typename, and the given string as its EID.

pub fn components(self) -> (EntityType, Eid)

Split into the EntityType representing the entity type, and the Eid representing its name

pub fn loc(&self) -> Option<&Loc>

Get the source location for this EntityUID.

pub fn from_components(ty: EntityType, eid: Eid, loc: Option<Loc>) -> Self

Create an EntityUID with the given typename and Eid

pub fn entity_type(&self) -> &EntityType

Get the type component.

pub fn eid(&self) -> &Eid

Get the Eid component.

pub fn is_action(&self) -> bool

Does this EntityUID refer to an action entity?

Trait Implementations

impl Clone for EntityUID

fn clone(&self) -> EntityUID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityUID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityUID

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de, C: DeserializationContext> DeserializeAs<'de, EntityUID> for EntityUidJson<C>

fn deserialize_as<D>(deserializer: D) -> Result<EntityUID, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EntityUID

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

Formats the value using the given formatter.

impl From<&EntityUID> for EntityUidJson

Convert an EntityUID to EntityUidJson, using the ExplicitEntityEscape option

fn from(uid: &EntityUID) -> EntityUidJson

Converts to this type from the input type.

impl From<&EntityUID> for TypeAndId

fn from(euid: &EntityUID) -> TypeAndId

Converts to this type from the input type.

impl From<EntityUID> for EntityReference

fn from(euid: EntityUID) -> Self

Converts to this type from the input type.

impl From<EntityUID> for EntityUidJson

Convert an EntityUID to EntityUidJson, using the ExplicitEntityEscape option

fn from(uid: EntityUID) -> EntityUidJson

Converts to this type from the input type.

impl From<EntityUID> for Literal

Create a Literal directly from an EntityUID

fn from(e: EntityUID) -> Self

Converts to this type from the input type.

impl From<EntityUID> for TypeAndId

fn from(euid: EntityUID) -> TypeAndId

Converts to this type from the input type.

impl FromNormalizedStr for EntityUID

fn describe_self() -> &'static str

Short string description of the Self type, to be used in error messages. What are we trying to parse?

fn from_normalized_str(s: &str) -> Result<Self, ParseErrors>

Create a Self by parsing a string, which is required to be normalized. That is, the input is required to roundtrip with the Display impl on Self: Self::from_normalized_str(x).to_string() == x must hold.

impl FromStr for EntityUID

type Err = ParseErrors

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 EntityUID

where EntityType: Hash, Eid: Hash,

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 EntityUID

where EntityType: Ord, Eid: Ord, Self: Eq,

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

where EntityType: PartialEq, Eid: PartialEq,

fn eq(&self, other: &Self) -> 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 PartialOrd for EntityUID

where EntityType: Ord, Eid: Ord, Self: Eq,

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> SerializeAs<EntityUID> for EntityUidJson<C>

fn serialize_as<S>(source: &EntityUID, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticallyTyped for EntityUID

fn type_of(&self) -> Type

Get the object’s type

impl TCNode<EntityUID> for Arc<Entity>

fn get_key(&self) -> EntityUID

Extract a unique identifier for the node.

fn add_edge_to(&mut self, k: EntityUID)

Add an edge out off this node to the node with key k.

fn out_edges(&self) -> Box<dyn Iterator<Item = &EntityUID> + '_>

Retrieve an iterator for the edges out of this node.

fn has_edge_to(&self, e: &EntityUID) -> bool

Return true when their is an edge between this node and the node with key k.

impl TCNode<EntityUID> for Entity

fn get_key(&self) -> EntityUID

Extract a unique identifier for the node.

fn add_edge_to(&mut self, k: EntityUID)

Add an edge out off this node to the node with key k.

fn out_edges(&self) -> Box<dyn Iterator<Item = &EntityUID> + '_>

Retrieve an iterator for the edges out of this node.

fn has_edge_to(&self, e: &EntityUID) -> bool

Return true when their is an edge between this node and the node with key k.

impl TryFrom<TypeAndId> for EntityUID

type Error = ParseErrors

The type returned in the event of a conversion error.

fn try_from(e: TypeAndId) -> Result<EntityUID, Self::Error>

Performs the conversion.

impl Eq for EntityUID

where EntityType: PartialEq, Eid: PartialEq,