Struct BroadcastOptions

Source
pub struct BroadcastOptions {
    pub rooms: SmallVec<[Room; 4]>,
    pub except: SmallVec<[Room; 4]>,
    pub sid: Option<Sid>,
    pub server_id: Option<Uid>,
    /* private fields */
}
Expand description

Options that can be used to modify the behavior of the broadcast methods.

Fields§

§rooms: SmallVec<[Room; 4]>

The rooms to broadcast to.

§except: SmallVec<[Room; 4]>

The rooms to exclude from the broadcast.

§sid: Option<Sid>

The socket id of the sender.

§server_id: Option<Uid>

The target server id can be used to optimize the broadcast. More specifically when we use broadcasting to apply a single action on a remote socket. We now the server_id of the remote socket, so we can send the action directly to the server.

Implementations§

Source§

impl BroadcastOptions

Source

pub fn add_flag(&mut self, flag: BroadcastFlags)

Add any flags to the options.

Source

pub fn has_flag(&self, flag: BroadcastFlags) -> bool

Check if the options have a flag.

Source

pub fn flags(&self) -> u8

get the flags of the options.

Source

pub fn new(sid: Sid) -> Self

Set the socket id of the sender.

Source

pub fn new_remote(data: &RemoteSocketData) -> Self

Create a new broadcast options from a remote socket data.

Source

pub fn is_local(&self, uid: Uid) -> bool

Check if the selected options are local to the current server.

Trait Implementations§

Source§

impl Clone for BroadcastOptions

Source§

fn clone(&self) -> BroadcastOptions

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BroadcastOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BroadcastOptions

Source§

fn default() -> BroadcastOptions

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BroadcastOptions

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for BroadcastOptions

Source§

fn eq(&self, other: &BroadcastOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for BroadcastOptions

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for BroadcastOptions

Source§

impl StructuralPartialEq for BroadcastOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,