Enum ChatPacket

pub enum ChatPacket {
    System(Arc<ClientboundSystemChat>),
    Player(Arc<ClientboundPlayerChat>),
    Disguised(Arc<ClientboundDisguisedChat>),
}

A chat packet, either a system message or a chat message.

Variants

System(Arc<ClientboundSystemChat>)

Player(Arc<ClientboundPlayerChat>)

Disguised(Arc<ClientboundDisguisedChat>)

Implementations

impl ChatPacket

pub fn message(&self) -> FormattedText

Get the message shown in chat for this packet.

pub fn split_sender_and_content(&self) -> (Option<String>, String)

Determine the username of the sender and content of the message. This does not preserve formatting codes. If it’s not a player-sent chat message or the sender couldn’t be determined, the username part will be None.

pub fn sender(&self) -> Option<String>

Get the username of the sender of the message. If it’s not a player-sent chat message or the sender couldn’t be determined, this will be None.

pub fn sender_uuid(&self) -> Option<Uuid>

Get the UUID of the sender of the message. If it’s not a player-sent chat message, this will be None (this is sometimes the case when a server uses a plugin to modify chat messages).

pub fn content(&self) -> String

Get the content part of the message as a string. This does not preserve formatting codes. If it’s not a player-sent chat message or the sender couldn’t be determined, this will contain the entire message.

pub fn new(message: &str) -> ChatPacket

Create a new Chat from a string. This is meant to be used as a convenience function for testing.

pub fn is_whisper(&self) -> bool

Whether this message is an incoming whisper message (i.e. someone else dm’d the bot with /msg). It works by checking the translation key, so it won’t work on servers that use their own whisper system.

Trait Implementations

impl Clone for ChatPacket

fn clone(&self) -> ChatPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatPacket

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

Formats the value using the given formatter.

impl PartialEq for ChatPacket

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