Enum ambient_api::message::Source

pub enum Source {
    Runtime,
    Server,
    Client {
        user_id: String,
    },
    Local(EntityId),
}

Where a message came from.

Variants

Runtime

This message came from the runtime.

Server

Available on crate feature client only.

This message came from the corresponding serverside package.

Client

Fields

user_id: String

The user that sent this message.

Available on crate feature server only.

This message came from the corresponding clientside package and was sent from user_id.

Local(EntityId)

This message came from another package on this side.

Implementations

impl Source

pub fn runtime(&self) -> bool

Is this message from the runtime?

pub fn server(&self) -> bool

Available on crate feature client only.

Is this message from the corresponding serverside package?

pub fn client_user_id(&self) -> Option<String>

Available on crate feature server only.

The user that sent this message, if any.

pub fn client_entity_id(&self) -> Option<EntityId>

Available on crate feature server only.

The entity ID of the player that sent this message, if any.

pub fn local(&self) -> Option<EntityId>

The module on this side that sent this message, if any.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl Ord for Source

fn cmp(&self, other: &Source) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Source

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

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

impl StructuralEq for Source

impl StructuralPartialEq for Source