Skip to main content

ChatEvent

steam_client::client

Enum ChatEvent 

Source 
pub enum ChatEvent {
    FriendMessage {
        sender: SteamID,
        message: String,
        chat_entry_type: EChatEntryType,
        timestamp: u32,
        ordinal: u32,
        from_limited_account: bool,
        low_priority: bool,
    },
    FriendMessageEcho {
        receiver: SteamID,
        message: String,
        timestamp: u32,
        ordinal: u32,
    },
    FriendTyping {
        sender: SteamID,
    },
    FriendTypingEcho {
        receiver: SteamID,
    },
    FriendLeftConversation {
        sender: SteamID,
    },
    FriendLeftConversationEcho {
        receiver: SteamID,
    },
    ChatMessage {
        chat_group_id: u64,
        chat_id: u64,
        sender: SteamID,
        message: String,
        timestamp: u32,
        ordinal: u32,
    },
    ChatMemberStateChange {
        chat_group_id: u64,
        steam_id: SteamID,
        change: i32,
    },
    ChatRoomGroupRoomsChange {
        chat_group_id: u64,
        default_chat_id: u64,
        chat_rooms: Vec<ChatRoomState>,
    },
    ChatMessagesModified {
        chat_group_id: u64,
        chat_id: u64,
        messages: Vec<ModifiedChatMessage>,
    },
    ChatRoomGroupHeaderStateChange {
        chat_group_id: u64,
        header_state: ChatRoomGroupHeaderState,
    },
    OfflineMessagesFetched {
        friend_id: SteamID,
        messages: Vec<HistoryMessage>,
    },
}
Expand description

Chat and messaging events.

Variants§

§

FriendMessage

Received a friend message.

Fields

§sender: SteamID
§message: String
§chat_entry_type: EChatEntryType
§timestamp: u32
§ordinal: u32
§from_limited_account: bool

Whether the message is from a limited account.

§low_priority: bool

Whether this is a low priority message.

§

FriendMessageEcho

Echo of a message we sent (received when local_echo is true).

Fields

§receiver: SteamID
§message: String
§timestamp: u32
§ordinal: u32
§

FriendTyping

Friend typing indicator.

Fields

§sender: SteamID
§

FriendTypingEcho

Echo of our own typing indicator.

Fields

§receiver: SteamID
§

FriendLeftConversation

Friend left the conversation.

Fields

§sender: SteamID
§

FriendLeftConversationEcho

Echo of us leaving the conversation.

Fields

§receiver: SteamID
§

ChatMessage

Received a group chat message.

Fields

§chat_group_id: u64
§chat_id: u64
§sender: SteamID
§message: String
§timestamp: u32
§ordinal: u32
§

ChatMemberStateChange

A member’s state in a chat room group changed.

Fields

§chat_group_id: u64
§steam_id: SteamID
§change: i32
§

ChatRoomGroupRoomsChange

Rooms in a chat room group changed.

Fields

§chat_group_id: u64
§default_chat_id: u64
§chat_rooms: Vec<ChatRoomState>
§

ChatMessagesModified

Chat messages in a room were modified (e.g. deleted).

Fields

§chat_group_id: u64
§chat_id: u64
§messages: Vec<ModifiedChatMessage>
§

ChatRoomGroupHeaderStateChange

A chat room group’s header state changed.

Fields

§chat_group_id: u64
§header_state: ChatRoomGroupHeaderState
§

OfflineMessagesFetched

Fetched offline messages history.

Fields

§friend_id: SteamID
§messages: Vec<HistoryMessage>

Trait Implementations§

Source§

impl Clone for ChatEvent

Source§

fn clone(&self) -> ChatEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChatEvent

Source§

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

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more