Struct pretty_exec::clap_utilities::CompletionGenerator

[−]

pub struct CompletionGenerator { /* private fields */ }

Expand description

Generate completions.

Implementations

impl CompletionGenerator

pub fn run<App>(self) -> Result<(), Error>where
App: CommandFactory,

Run the generator.

pub fn main<App>() -> ExitCodewhere
App: CommandFactory,

The program that generates shell completions.

Trait Implementations

impl Args for CompletionGenerator

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args(__clap_app: Command) -> Command

Append to Command so it can instantiate Self. Read more

fn augment_args_for_update(__clap_app: Command) -> Command

Append to Command so it can update self. Read more

impl CommandFactory for CompletionGenerator

fn command() -> Command

Build a Command that can instantiate Self. Read more

fn command_for_update() -> Command

Build a Command that can update self. Read more

impl Debug for CompletionGenerator

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

Formats the value using the given formatter. Read more

impl FromArgMatches for CompletionGenerator

fn from_arg_matches(
__clap_arg_matches: &ArgMatches
) -> Result<CompletionGenerator, Error<RichFormatter>>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more

fn from_arg_matches_mut(
__clap_arg_matches: &mut ArgMatches
) -> Result<CompletionGenerator, Error<RichFormatter>>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more

fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error<RichFormatter>>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut(
&mut self,
__clap_arg_matches: &mut ArgMatches
) -> Result<(), Error<RichFormatter>>

Assign values from ArgMatches to self.

impl Parser for CompletionGenerator

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Auto Trait Implementations

impl RefUnwindSafe for CompletionGenerator

impl Send for CompletionGenerator

impl Sync for CompletionGenerator

impl Unpin for CompletionGenerator

impl UnwindSafe for CompletionGenerator

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<App> CommandFactoryExtra for Appwhere
App: CommandFactory,

fn get_completion<Completion, Name>(name: Name, shell: Shell) -> Completionwhere
Completion: Write + Default,
Name: Into<String>,

Get completion content.

fn get_completion_string(
name: impl Into<String>,
shell: Shell
) -> Result<String, Utf8Error>

Get completion string.

fn generate_completion(generator: CompletionGenerator) -> Result<(), Error>

Generate a shell completion file.

fn run_completion_generator() -> ExitCode

Create and run the completion generator.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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.

impl<X> Pipe for X

fn pipe<Return, Function>(self, f: Function) -> Returnwhere
Function: FnOnce(Self) -> Return,

Apply f to self. Read more

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere
Function: FnOnce(&'a Self) -> Return,

Apply f to &self. Read more

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Function: FnOnce(&'a mut Self) -> Return,

Apply f to &mut self. Read more

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
 Self: AsRef<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait AsRef<Param>. Read more

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Returnwhere
 Self: AsMut<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait AsMut<Param>. Read more

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
 Self: Deref<Target = Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Deref<Target = Param>. Read more

fn pipe_deref_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Returnwhere
 Self: DerefMut<Target = Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait [DerefMut<Target = Param>]. Read more

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
 Self: Borrow<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Borrow<Param>. Read more

fn pipe_borrow_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Returnwhere
 Self: BorrowMut<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait BorrowMut<Param>. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct pretty_exec::clap_utilities::CompletionGenerator

Implementations

impl CompletionGenerator

pub fn run<App>(self) -> Result<(), Error>where App: CommandFactory,

pub fn main<App>() -> ExitCodewhere App: CommandFactory,

Trait Implementations

impl Args for CompletionGenerator

fn group_id() -> Option<Id>

fn augment_args(__clap_app: Command) -> Command

fn augment_args_for_update(__clap_app: Command) -> Command

impl CommandFactory for CompletionGenerator

fn command() -> Command

fn command_for_update() -> Command

impl Debug for CompletionGenerator

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

impl FromArgMatches for CompletionGenerator

fn from_arg_matches( __clap_arg_matches: &ArgMatches) -> Result<CompletionGenerator, Error<RichFormatter>>

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches) -> Result<CompletionGenerator, Error<RichFormatter>>

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches) -> Result<(), Error<RichFormatter>>

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches) -> Result<(), Error<RichFormatter>>

impl Parser for CompletionGenerator

fn parse() -> Self

fn try_parse() -> Result<Self, Error<RichFormatter>>

fn parse_from<I, T>(itr: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

fn update_from<I, T>(&mut self, itr: I)where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Auto Trait Implementations

impl RefUnwindSafe for CompletionGenerator

impl Send for CompletionGenerator

impl Sync for CompletionGenerator

impl Unpin for CompletionGenerator

impl UnwindSafe for CompletionGenerator

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<App> CommandFactoryExtra for Appwhere App: CommandFactory,

fn get_completion<Completion, Name>(name: Name, shell: Shell) -> Completionwhere Completion: Write + Default, Name: Into<String>,

fn get_completion_string( name: impl Into<String>, shell: Shell) -> Result<String, Utf8Error>

fn generate_completion(generator: CompletionGenerator) -> Result<(), Error>

fn run_completion_generator() -> ExitCode

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<X> Pipe for X

fn pipe<Return, Function>(self, f: Function) -> Returnwhere Function: FnOnce(Self) -> Return,

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere Function: FnOnce(&'a Self) -> Return,

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere Function: FnOnce(&'a mut Self) -> Return,

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere Self: AsRef<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Returnwhere Self: AsMut<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere Self: Deref<Target = Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_deref_mut<'a, Param, Return, Function>( &'a mut self, f: Function) -> Returnwhere Self: DerefMut<Target = Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere Self: Borrow<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_borrow_mut<'a, Param, Return, Function>( &'a mut self, f: Function) -> Returnwhere Self: BorrowMut<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn run<App>(self) -> Result<(), Error>where
App: CommandFactory,

pub fn main<App>() -> ExitCodewhere
App: CommandFactory,

fn from_arg_matches(
__clap_arg_matches: &ArgMatches
) -> Result<CompletionGenerator, Error<RichFormatter>>

fn from_arg_matches_mut(
__clap_arg_matches: &mut ArgMatches
) -> Result<CompletionGenerator, Error<RichFormatter>>

fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error<RichFormatter>>

fn update_from_arg_matches_mut(
&mut self,
__clap_arg_matches: &mut ArgMatches
) -> Result<(), Error<RichFormatter>>

fn parse_from<I, T>(itr: I) -> Selfwhere
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

fn update_from<I, T>(&mut self, itr: I)where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<App> CommandFactoryExtra for Appwhere
App: CommandFactory,

fn get_completion<Completion, Name>(name: Name, shell: Shell) -> Completionwhere
Completion: Write + Default,
Name: Into<String>,

fn get_completion_string(
name: impl Into<String>,
shell: Shell
) -> Result<String, Utf8Error>

impl<T, U> Into<U> for Twhere
U: From<T>,

fn pipe<Return, Function>(self, f: Function) -> Returnwhere
Function: FnOnce(Self) -> Return,

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere
Function: FnOnce(&'a Self) -> Return,

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Function: FnOnce(&'a mut Self) -> Return,

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
Self: AsRef<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Self: AsMut<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
Self: Deref<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_deref_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function
) -> Returnwhere
Self: DerefMut<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
Self: Borrow<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_borrow_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function
) -> Returnwhere
Self: BorrowMut<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,