Skip to main content

Program

Struct Program 

Source
pub struct Program<'a> {
    pub name: &'a str,
    pub version: &'a str,
    pub about: &'a str,
    pub commands: &'a [Command<'a>],
    pub exit_status: &'a [(&'a str, &'a str)],
    pub see_also: &'a [&'a str],
    pub date: &'a str,
    pub asked: &'a [Asked<'a>],
}
Expand description

What the generators need to know about the program that the inputs do not say.

Fields§

§name: &'a str

The executable’s name, as typed (snapall).

§version: &'a str

The version shown in the man page footer.

§about: &'a str

One line, for the man page’s NAME section.

§commands: &'a [Command<'a>]

Subcommands, in the order they should be listed. May be empty.

§exit_status: &'a [(&'a str, &'a str)]

(status, meaning) pairs for the man page’s EXIT STATUS section.

§see_also: &'a [&'a str]

Other manual pages, such as snapper(8).

§date: &'a str

The man page date, YYYY-MM-DD. A parameter, not a clock reading, so output is reproducible.

§asked: &'a [Asked<'a>]

Positional arguments whose values only the program knows at the moment Tab is pressed (names of files in the current folder, records in a store). May be empty.

Trait Implementations§

Source§

impl<'a> Clone for Program<'a>

Source§

fn clone(&self) -> Self

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> Copy for Program<'a>

Source§

impl<'a> Debug for Program<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Forget for Program<'a>

§

impl<'a> Freeze for Program<'a>

§

impl<'a> Move for Program<'a>

§

impl<'a> RefUnwindSafe for Program<'a>

§

impl<'a> Send for Program<'a>

§

impl<'a> Sync for Program<'a>

§

impl<'a> Unpin for Program<'a>

§

impl<'a> UnsafeUnpin for Program<'a>

§

impl<'a> UnwindSafe for Program<'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, !>

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.