Struct EntityId

pub struct EntityId(/* private fields */);

Identifier portion of the EntityUid type.

All strings are valid EntityIds, and can be constructed either using EntityId::new or by using the implementation of FromStr. This implementation is Infallible, so the parsed EntityId can be extracted safely.

let id : EntityId = "my-id".parse().unwrap_or_else(|never| match never {});

EntityId does not implement Display, partly because it is unclear whether Display should produce an escaped representation or an unescaped representation (see #884). To get an escaped representation, use .escaped(). To get an unescaped representation, use .unescaped() or .as_ref().

Implementations

impl EntityId

pub fn new(src: impl AsRef<str>) -> Self

Construct an EntityId from a source string

pub fn escaped(&self) -> SmolStr

Get the contents of the EntityId as an escaped string

pub fn unescaped(&self) -> &str

Get the contents of the EntityId as an unescaped string

Trait Implementations

impl AsRef<str> for EntityId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EntityId

fn clone(&self) -> EntityId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityId

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

Formats the value using the given formatter.

impl FromStr for EntityId

type Err = Infallible

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for EntityId

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 EntityId

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

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

fn partial_cmp(&self, other: &EntityId) -> 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 RefCast for EntityId

type From = Eid

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl Eq for EntityId

impl StructuralPartialEq for EntityId