Struct SquadMessage

#[repr(C)]
pub struct SquadMessage {
    pub channel_id: u32,
    pub channel_type: ChannelType,
    pub subgroup: u8,
    /* private fields */
}

A squad/party chat message.

Strings are available for the duration of the call. If you need it for longer than that, consider converting it to SquadMessageOwned.

let owned = message.to_owned();
let owned: SquadMessageOwned = message.into();

Fields

channel_id: u32

A unique identifier for the channel this chat message was sent over.

Can be used to, for example, differentiate between squad messages sent to different squads.

channel_type: ChannelType

Whether the message is sent in a party or a squad.

Note that messages sent to the party chat while in a squad will have the type ChannelType::Squad.

subgroup: u8

The subgroup the message was sent to, or 0 if it was sent to the entire squad.

Implementations

impl SquadMessage

pub fn to_owned(&self) -> SquadMessageOwned

Converts the squad message to its owned counterpart.

pub fn flags_raw(&self) -> u8

Returns the raw message flags.

pub fn flags(&self) -> SquadMessageFlags

Returns the message flags.

pub fn is_broadcast(&self) -> bool

Returns the message flags.

pub fn timestamp_str(&self) -> &str

Returns the timestamp as string.

pub fn timestamp_ptr(&self) -> *const c_char

Returns the timestamp string as raw pointer.

pub fn timestamp_len(&self) -> usize

Returns the timestamp string length.

pub fn timestamp(&self) -> Option<DateTime<FixedOffset>>

Returns the timestamp when the message was received.

This is the “absolute ordering” for chat messages, however the time can potentially differ several seconds between the client and server because of latency and clock skew.

pub fn account_name(&self) -> &str

Returns the account name of the player that sent the message.

pub fn account_name_ptr(&self) -> *const c_char

Returns the account name as raw pointer.

pub fn account_name_len(&self) -> usize

Returns the account name length.

pub fn character_name(&self) -> &str

Returns the character name of the player that sent the message.

pub fn character_name_ptr(&self) -> *const c_char

Returns the character name as raw pointer.

pub fn character_name_len(&self) -> usize

Returns the account name length.

pub fn text(&self) -> &str

Returns the text content of the message.

pub fn text_ptr(&self) -> *const c_char

Returns the text as raw pointer.

pub fn text_len(&self) -> usize

Returns the account name length.

Trait Implementations

impl Clone for SquadMessage

fn clone(&self) -> SquadMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SquadMessage

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

Formats the value using the given formatter.

impl From<&SquadMessage> for SquadMessageOwned

fn from(msg: &SquadMessage) -> Self

Converts to this type from the input type.

impl From<SquadMessage> for SquadMessageOwned

fn from(msg: SquadMessage) -> Self

Converts to this type from the input type.