Skip to main content

VersionConfig

Struct VersionConfig 

Source
pub struct VersionConfig {
    pub default_output: Option<OutputFormat>,
    pub output_flag: Option<&'static str>,
    pub output_short: Option<char>,
    pub allow_output_format: bool,
}
Expand description

Configuration for pre-parser --version handling.

This helper scans raw argv before the application’s argument parser so --version --output json can return an AFDATA event instead of letting clap or another parser print conventional plain text and exit.

Fields§

§default_output: Option<OutputFormat>

Format used for --version when no explicit output flag is present.

Some(format) renders an AFDATA {code:"version", ...} event in that format. None preserves conventional CLI output: <name> <version>.

§output_flag: Option<&'static str>

Optional long output flag to read, for example --output.

§output_short: Option<char>

Optional short output flag to read, for example -o.

§allow_output_format: bool

Whether an explicit output flag can override default_output.

Implementations§

Source§

impl VersionConfig

Source

pub const fn new(default_output: Option<OutputFormat>) -> Self

Construct a custom version handler configuration.

Source

pub const fn agent_cli_default() -> Self

Structured bare-version preset.

A bare --version is a JSON AFDATA event. Most CLIs should prefer Self::conventional_default so human --version stays familiar while explicit --output json|yaml|plain remains structured.

Source

pub const fn conventional_default() -> Self

Recommended preset: keep conventional bare version text while still honoring explicit --output json|yaml|plain.

Source

pub const fn with_default_output( self, default_output: Option<OutputFormat>, ) -> Self

Return a copy with a different default output.

Source

pub const fn with_output_flag(self, flag: Option<&'static str>) -> Self

Return a copy with a different long output flag.

Source

pub const fn with_output_short(self, flag: Option<char>) -> Self

Return a copy with a different short output flag.

Source

pub const fn with_output_format_override(self, enabled: bool) -> Self

Return a copy that enables or disables explicit output overrides.

Trait Implementations§

Source§

impl Clone for VersionConfig

Source§

fn clone(&self) -> VersionConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for VersionConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for VersionConfig

Source§

impl PartialEq for VersionConfig

Source§

fn eq(&self, other: &VersionConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for VersionConfig

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.