Struct weasel::event::ClientEventPrototype

pub struct ClientEventPrototype<R: BattleRules> { /* fields omitted */ }

An event prototype sent by a client to a server that must be first verified before being processed.

Implementations

impl<R: BattleRules> ClientEventPrototype<R>

pub fn version(&self) -> &Version<R>

Returns the BattleRules's version of the event.

pub fn origin(&self) -> Option<EventId>

Returns the id of the event that caused this one.

pub fn event(&self) -> &Box<dyn Event<R> + Send>

Returns the event.

pub fn authenticate(&mut self, player: PlayerId)

Authenticate this event with the identity of player.

Note: you can use this method to perform server-side authentication of events coming from a remote client.

pub fn player(&self) -> Option<PlayerId>

Returns the player who fired this prototype.

Methods from Deref<Target = Box<dyn Event<R> + Send>>

Trait Implementations

impl<R: BattleRules> Clone for ClientEventPrototype<R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: BattleRules> Deref for ClientEventPrototype<R>

type Target = Box<dyn Event<R> + Send>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<R: BattleRules + 'static> From<ClientEventPrototype<R>> for FlatClientEvent<R>

fn from(event: ClientEventPrototype<R>) -> Self

Performs the conversion.

impl<R: BattleRules + 'static> From<FlatClientEvent<R>> for ClientEventPrototype<R>

fn from(event: FlatClientEvent<R>) -> Self

Performs the conversion.