Skip to main content

StatsPlugin

room_cli::plugin::stats

Struct StatsPlugin

pub struct StatsPlugin;

Expand description

Example /stats plugin. Shows a statistical summary of recent chat activity: message count, participant count, time range, most active user.

/summarise is reserved for LLM-powered v2 — the core binary does not depend on any LLM SDK.

Trait Implementations§

impl Plugin for StatsPlugin

fn name(&self) -> &str

Unique identifier for this plugin (e.g. "stats", "help").

fn version(&self) -> &str

Semantic version of this plugin (e.g. "1.0.0"). Read more

fn commands(&self) -> Vec<CommandInfo>

Commands this plugin handles. Each entry drives /help output and TUI autocomplete. Read more

fn handle( &self, ctx: CommandContext, ) -> Pin<Box<dyn Future<Output = Result<PluginResult, Error>> + Send + '_>>

Handle an invocation of one of this plugin’s commands. Read more

fn api_version(&self) -> u32

Plugin API version this plugin was written against. Read more

fn min_protocol(&self) -> &str

Minimum room-protocol crate version this plugin requires, as a semver string (e.g. "3.1.0"). Read more

fn on_user_join(&self, _user: &str)

Called after a user joins the room. The default is a no-op. Read more

fn on_user_leave(&self, _user: &str)

Called after a user leaves the room. The default is a no-op. Read more

Auto Trait Implementations§

impl Freeze for StatsPlugin

impl RefUnwindSafe for StatsPlugin

impl Send for StatsPlugin

impl Sync for StatsPlugin

impl Unpin for StatsPlugin

impl UnsafeUnpin for StatsPlugin

impl UnwindSafe for StatsPlugin

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,