Struct ambient_api_core::global::EntityId

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

An identifier for an entity in the world.

Implementations

impl EntityId

pub fn from_base64(encoded: &str) -> Self

Create a new EntityId from a Base64 representation.

Panics

This will panic if

• the Base64 string is more than 16 bytes
• the Base64 string is not a valid EntityId.

pub fn to_base64(&self) -> String

Convert this EntityId to a Base64 representation.

pub const fn null() -> Self

Return a null EntityId

pub const fn is_null(&self) -> bool

Returns true if this is a null EntityId

pub fn resources() -> Self

Return an EntityId pointing to the resources entity

pub fn is_resources(&self) -> bool

Returns true if this is pointing to a resources entity

Trait Implementations

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 Default for EntityId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EntityId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EntityId

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

Formats the value using the given formatter.

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 MessageSerde for EntityId

fn serialize_message_part( &self, output: &mut Vec<u8> ) -> Result<(), MessageSerdeError>

Serialize this to a Vec<u8>.

fn deserialize_message_part( input: &mut dyn Read ) -> Result<Self, MessageSerdeError>

Deserialize this if possible.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for EntityId

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for EntityId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SupportedValue for EntityId

fn from_value(value: ComponentValue) -> Option<Self>

Converts a ComponentValue into a Self.

fn into_value(self) -> ComponentValue

Converts a Self into a ComponentValue.

impl Copy for EntityId

impl Eq for EntityId

impl StructuralEq for EntityId

impl StructuralPartialEq for EntityId