ToastyCli

Struct ToastyCli 

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

A CLI runner that dispatches migration subcommands against a [Db].

ToastyCli holds a database connection and a Config. Call parse_and_run to parse std::env::args and execute the matching subcommand, or parse_from to parse from an arbitrary iterator (useful for testing).

§Examples

use toasty_cli::{ToastyCli, Config, MigrationConfig};

let config = Config::new()
    .migration(MigrationConfig::new().path("db"));
let db = toasty::Db::builder("sqlite::memory:").build().await?;
let cli = ToastyCli::with_config(db, config);
cli.parse_from(["toasty", "migration", "apply"]).await?;

Implementations§

Source§

impl ToastyCli

Source

pub fn new(db: Db) -> Self

Create a new ToastyCli instance with the given database connection

Source

pub fn with_config(db: Db, config: Config) -> Self

Create a new ToastyCli instance with a custom configuration

Source

pub fn config(&self) -> &Config

Get a reference to the configuration

Source

pub async fn parse_and_run(&self) -> Result<()>

Parse and execute CLI commands from command-line arguments

Source

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

Parse and execute CLI commands from an iterator of arguments

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.

§

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

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