Struct DriverOutput 

pub struct DriverOutput<T> {
    pub value: T,
    pub report: DriverReport,
    /* private fields */
}

Successful driver output: a typed value plus an execution report.

This is returned when parsing succeeds. It contains:

• The parsed value of type T
• A DriverReport with diagnostics and metadata

Example

use facet::Facet;
use figue::{self as args, FigueBuiltins};

#[derive(Facet, Debug)]
struct Args {
    #[facet(args::named, default)]
    verbose: bool,

    #[facet(flatten)]
    builtins: FigueBuiltins,
}

let result = figue::from_slice::<Args>(&["--verbose"]).into_result();
let output = result.unwrap();

// Access the parsed value
assert!(output.value.verbose);

// Or get the value with warnings printed
// let args = output.get();

Fields

value: T

The fully-typed value produced by deserialization.

report: DriverReport

Diagnostics and metadata produced by the driver.

Implementations

impl<T> DriverOutput<T>

pub fn get(self) -> T

Get the value, printing any warnings to stderr.

pub fn get_silent(self) -> T

Get the value silently (no warning output).

pub fn into_parts(self) -> (T, DriverReport)

Get value and report separately.

pub fn print_warnings(&self)

Print any warnings to stderr.

pub fn extract<R: Facet<'static>>(&self) -> Result<R, ExtractError>

Extract a requirements struct from the parsed configuration.

This allows subcommand-specific validation of required fields. The requirements struct should have fields annotated with #[facet(args::origin = "path")] to indicate which values from the config should be extracted.

Example

use figue as args;

#[derive(Facet)]
struct MigrateRequirements {
    #[facet(args::origin = "config.database_url")]
    database_url: String,  // Required for this context

    #[facet(args::origin = "config.migrations_path")]
    migrations_path: PathBuf,
}

let output = figue::builder::<Args>()?.cli(|c| c.from_std_args()).build().run()?;

match output.value.command {
    Command::Migrate => {
        let req: MigrateRequirements = output.extract()?;
        run_migrate(&req.database_url, &req.migrations_path);
    }
}

Errors

Returns an error if any required field (non-Option) is missing in the config, or if a field lacks the args::origin attribute.

Trait Implementations

impl<T: Debug> Debug for DriverOutput<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.