Struct MessageLog 

pub struct MessageLog { /* private fields */ }

The messages of one channel or conversation, ordered and bounded.

Implementations

impl MessageLog

pub fn with_retention(retention: usize) -> Self

An empty log holding at most this many messages.

pub fn insert(&mut self, message: ChatMessage) -> bool

Insert a message unless we already have it, returning whether it was new.

A message with an id is deduplicated by that id. One without is compared against the messages sharing its exact timestamp, which is enough to catch a replay while staying bounded: an unbounded content scan would be the only alternative.

pub fn contains(&self, msgid: &str) -> bool

True when a message with this id is already held.

pub fn get(&self, msgid: &str) -> Option<&ChatMessage>

Look one up by its network id.

pub fn get_mut(&mut self, msgid: &str) -> Option<&mut ChatMessage>

Borrow one mutably by its network id, to attach a reaction or mark it redacted.

pub fn get_by_key(&self, key: &MessageKey) -> Option<&ChatMessage>

Look one up by where it sits in this log.

Change::MessageAdded reports a key rather than the message, so this is how a host turns that notification into the message it names.

pub fn iter(&self) -> Values<'_, MessageKey, ChatMessage>

Every message, oldest first.

pub fn last(&self) -> Option<&ChatMessage>

The most recent message.

pub fn first(&self) -> Option<&ChatMessage>

The oldest message held, which is where a history request should resume from.

pub fn len(&self) -> usize

How many are held.

pub fn is_empty(&self) -> bool

True when nothing is held.

Trait Implementations

impl Clone for MessageLog

fn clone(&self) -> MessageLog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageLog

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

Formats the value using the given formatter.

impl Default for MessageLog

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageLog

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> IntoIterator for &'a MessageLog

type Item = &'a ChatMessage

The type of the elements being iterated over.

type IntoIter = Values<'a, MessageKey, ChatMessage>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for MessageLog

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for MessageLog

const DOCS: Option<&'static str>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

type WithoutGenerics = MessageLog

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use [TS::export_all].

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.