Struct clap_utilities::completion_generator::CompletionGenerator

source · [−]

pub struct CompletionGenerator { /* private fields */ }

Expand description

Generate completions.

Implementations

source

impl CompletionGenerator

source

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

Run the generator.

source

pub fn main<App: CommandFactory>() -> ExitCode

The program that generates shell completions.

Trait Implementations

source

impl Args for CompletionGenerator

source

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self. Read more

source

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self. Read more

source

impl CommandFactory for CompletionGenerator

source

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

source

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

source

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self. Read more

source

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self. Read more

source

impl Debug for CompletionGenerator

source

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

Formats the value using the given formatter. Read more

source

impl FromArgMatches for CompletionGenerator

source

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

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

source

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

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

source

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

Assign values from ArgMatches to self.

source

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

Assign values from ArgMatches to self.

source

impl Parser for CompletionGenerator

source

fn parse() -> Self

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

source

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

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

source

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

Parse from iterator, exit on error

source

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

Parse from iterator, return Err on error.

source

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

Update from iterator, exit on error

source

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error> 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 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<App> CommandFactoryExtra for App where
App: CommandFactory,

source

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

Get completion content.

source

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

Get completion string.

source

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

Generate a shell completion file.

source

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 T where
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.

source

impl<X> Pipe for X

source

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

Apply f to self. Read more

source

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

Apply f to &self. Read more

source

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

Apply f to &mut self. Read more

source

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
 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

source

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Return where
 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

source

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
 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

source

fn pipe_deref_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Return where
 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

source

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
 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

source

fn pipe_borrow_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Return where
 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 T where
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 T where
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 clap_utilities::completion_generator::CompletionGenerator

Implementations

impl CompletionGenerator

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

pub fn main<App: CommandFactory>() -> ExitCode

Trait Implementations

impl Args for CompletionGenerator

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

impl CommandFactory for CompletionGenerator

fn into_app<'b>() -> Command<'b>

fn into_app_for_update<'b>() -> Command<'b>

fn command<'help>() -> App<'help>

fn command_for_update<'help>() -> App<'help>

impl Debug for CompletionGenerator

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

impl FromArgMatches for CompletionGenerator

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

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

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

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

impl Parser for CompletionGenerator

fn parse() -> Self

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

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

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error> 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> 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 T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<App> CommandFactoryExtra for App where App: CommandFactory,

fn get_completion<Completion, Name>(name: Name, shell: Shell) -> Completion where 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 T where U: From<T>,

fn into(self) -> U

impl<X> Pipe for X

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

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

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

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

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

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where 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) -> Return where Self: DerefMut<Target = Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

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

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error> 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> where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,

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

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

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

impl<App> CommandFactoryExtra for App where
App: CommandFactory,

fn get_completion<Completion, Name>(name: Name, shell: Shell) -> Completion where
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 T where
U: From<T>,

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

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

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

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

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

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
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
) -> Return where
Self: DerefMut<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

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

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

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

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