Struct CommandEnvironment 

pub struct CommandEnvironment { /* private fields */ }

Implementations

impl CommandEnvironment

pub fn new() -> Self

pub fn create<F, Fut>(&mut self, name: &str, handler: F) -> Result<(), String>

where F: Fn(CommandContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = CommandResult> + Send + 'static,

Register a typed handler after validating the complete command name. Non-string names are rejected by the compiler before registry mutation.

use command_stream::{CommandEnvironment, CommandResult};
let mut environment = CommandEnvironment::new();
environment.create(None, |_| async { CommandResult::success_empty() });

use command_stream::{CommandEnvironment, CommandResult};
let mut environment = CommandEnvironment::new();
environment.create(42, |_| async { CommandResult::success_empty() });

pub fn list(&self) -> Vec<String>

pub fn unregister(&mut self, name: &str) -> bool

pub fn installed(&self, name: &str) -> Option<&CommandPackage>

pub fn get(&self, name: &str) -> Option<PackageHandler>

pub async fn run(&self, name: &str, context: CommandContext) -> CommandResult

pub fn extend<F>(&mut self, name: &str, middleware: F) -> Result<(), String>

where F: Fn(CommandContext, PackageHandler) -> HandlerFuture + Send + Sync + 'static,

pub fn inherit( &mut self, name: &str, parent: &str, args: Vec<String>, ) -> Result<(), String>

pub fn compose(&mut self, name: &str, names: &[&str]) -> Result<(), String>

pub fn install(&mut self, package: CommandPackage) -> Result<(), String>

Validate all commands before replacing a package, including when hot reloading.

pub fn install_with_options( &mut self, package: CommandPackage, options: InstallOptions, ) -> Result<(), String>

pub fn uninstall(&mut self, package: &str)

pub async fn install_file( &mut self, path: impl AsRef<Path>, ) -> Result<String, String>

Canonical file identity makes repeated installation idempotent, including symlinks.

pub async fn install_npm( &mut self, specifier: &str, cwd: impl AsRef<Path>, install: bool, ) -> Result<String, String>

Resolve an npm package containing command-stream.json. Rust executes its literal argv commands without evaluating JavaScript. Missing packages may be installed with npm lifecycle scripts disabled; install = false requires an existing package. Reload and uninstall use the same lifecycle.

pub async fn reload_file( &mut self, path: impl AsRef<Path>, ) -> Result<String, String>

Invalid manifests or collisions leave the installed version intact.

Trait Implementations

impl Default for CommandEnvironment

fn default() -> Self

Returns the “default value” for a type.