Struct BroadcastOptions

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

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

impl BroadcastOptions

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

Add any flags to the options.

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

Check if the options have a flag.

pub fn flags(&self) -> u8

get the flags of the options.

pub fn new(sid: Sid) -> Self

Set the socket id of the sender.

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

Create a new broadcast options from a remote socket data.

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

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

Trait Implementations

impl Clone for BroadcastOptions

fn clone(&self) -> BroadcastOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BroadcastOptions

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

Formats the value using the given formatter.

impl Default for BroadcastOptions

fn default() -> BroadcastOptions

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BroadcastOptions

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BroadcastOptions

impl StructuralPartialEq for BroadcastOptions