Skip to main content

SpecView

Struct SpecView 

Source
pub struct SpecView<'a> { /* private fields */ }
Expand description

A borrowed, sparse view over a derive-generated Spec.

Constructing a view copies no command tree and is never part of argv parsing. It exists for cold paths—help, spec emission and completion—where a program may need runtime identity or a centrally audited metadata policy without lowering the static tables through usage-lib.

Implementations§

Source§

impl<'a> SpecView<'a>

Source

pub const fn new(base: &'a Spec<'a>) -> SpecView<'a>

Source

pub fn name<'b, 'c>(self, name: &'b str) -> SpecView<'c>
where 'a: 'c, 'b: 'c,

Source

pub fn bin<'b, 'c>(self, bin: &'b str) -> SpecView<'c>
where 'a: 'c, 'b: 'c,

Source

pub fn version<'b, 'c>(self, version: &'b str) -> SpecView<'c>
where 'a: 'c, 'b: 'c,

Source

pub fn omit_version(self) -> SpecView<'a>

Leave the runtime version out of emitted specs and other metadata consumers.

The parser’s built-in version response is unchanged because parsing reads the base spec. This is for checked-in generated artifacts whose version is managed independently.

Source

pub fn overlay<'b, 'c>(self, commands: &'b [CommandOverlay<'b>]) -> SpecView<'c>
where 'a: 'c, 'b: 'c,

Source

pub const fn spec(&self) -> Spec<'a>

The shallow effective spec. Its command metadata still borrows the derive’s static tree.

Source

pub fn to_kdl(self) -> String

Emit the effective view without constructing or mutating a command graph.

Trait Implementations§

Source§

impl<'a> Clone for SpecView<'a>

Source§

fn clone(&self) -> SpecView<'a>

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<'a> Debug for SpecView<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SpecView<'a>

§

impl<'a> RefUnwindSafe for SpecView<'a>

§

impl<'a> Send for SpecView<'a>

§

impl<'a> Sync for SpecView<'a>

§

impl<'a> Unpin for SpecView<'a>

§

impl<'a> UnsafeUnpin for SpecView<'a>

§

impl<'a> UnwindSafe for SpecView<'a>

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 = !

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.