Skip to main content

CliApp

Struct CliApp 

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

Builder entry point for the Kanban CLI.

A third-party backend crate constructs a CliApp, registers its own StoreFactory, and calls CliApp::run from its own main — owning the binary while reusing every CLI command here.

Implementations§

Source§

impl CliApp

Source

pub fn with_defaults() -> Self

Returns a CliApp pre-configured with all backends compiled in. SQLite is registered first so content-sniffing prefers it; JSON is registered as the catch-all fallback. When no backend features are active the registry is empty (same as Default).

Source

pub fn register_backend(self, factory: Box<dyn StoreFactory>) -> Self

Registers an additional backend factory. Order matters for content sniffing — factories registered earlier win when multiple match.

§Example — third-party binary with a custom backend

A crate that owns its own main can reuse every CLI command while injecting a proprietary storage backend:

use kanban_cli::CliApp;
use kanban_persistence::{PersistenceError, PersistenceStore, StoreFactory};
use std::sync::Arc;

// A backend factory provided by a third-party crate.
struct MyBackendFactory;
impl StoreFactory for MyBackendFactory {
    fn name(&self) -> &str { "my-backend" }
    fn create(
        &self,
        locator: &str,
    ) -> Result<Arc<dyn PersistenceStore + Send + Sync>, PersistenceError> {
        unimplemented!()
    }
}

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    CliApp::with_defaults()
        .register_backend(Box::new(MyBackendFactory))
        .run()
        .await
}
Source

pub fn with_config(self, config: AppConfig) -> Self

Overrides the AppConfig that run would otherwise load from disk.

Source

pub fn registry(&self) -> &StoreRegistry

Exposes the underlying registry for inspection and tests.

Source

pub async fn run(self) -> Result<()>

Executes the CLI: parses args, loads config, and dispatches to the requested command (or launches the TUI if no subcommand was given).

Source

pub async fn run_with_args<I, T>(self, args: I) -> Result<()>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Like [run], but accepts an explicit argument list instead of reading from std::env::args_os(). Useful for testing without spawning a subprocess.

Trait Implementations§

Source§

impl Default for CliApp

Source§

fn default() -> Self

Returns an empty CliApp with no registered backends. Callers must register at least one via CliApp::register_backend before run can produce a store.

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

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
Source§

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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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