Skip to main content

AgentPlugin

Struct AgentPlugin 

Source
pub struct AgentPlugin { /* private fields */ }
Expand description

Agent spawn/stop/list plugin.

Manages ralph agent processes spawned from within a room. Tracks PIDs, provides /agent spawn, /agent list, and /agent stop commands.

Implementations§

Source§

impl AgentPlugin

Source

pub fn new(state_path: PathBuf, socket_path: PathBuf, log_dir: PathBuf) -> Self

Create a new agent plugin.

Loads previously persisted agent state and prunes entries whose processes are no longer running.

Source

pub fn default_commands() -> Vec<CommandInfo>

Returns the command info for the TUI command palette without needing an instantiated plugin. Used by all_known_commands().

Trait Implementations§

Source§

impl Plugin for AgentPlugin

Source§

fn name(&self) -> &str

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

fn version(&self) -> &str

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

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

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

fn handle(&self, ctx: CommandContext) -> BoxFuture<'_, Result<PluginResult>>

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

fn api_version(&self) -> u32

Plugin API version this plugin was written against. Read more
Source§

fn min_protocol(&self) -> &str

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

fn on_user_join(&self, _user: &str)

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

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§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.