Struct combu::hook::Hook

pub struct Hook {
    pub name: String,
    pub action: Option<HookAction>,
    pub authors: String,
    pub copyright: String,
    pub license: Option<(String, String)>,
    pub description: Option<String>,
    pub usage: String,
    pub alias: Vector<String>,
}

Hook is struct for action needs a context before sub.run.

Fields

name: String

name

action: Option<HookAction>

action

authors: String

authors

copyright: String

copyright

license: Option<(String, String)>

license

description: Option<String>

description

usage: String

usage

alias: Vector<String>

alias

Implementations

impl Hook

pub fn new() -> Hook

Creates new hook.

pub fn with_name<T: Into<String>>(name: T) -> Hook

Creates new hook with name

pub fn with_all_field(
    name: String,
    action: Option<HookAction>,
    authors: String,
    copyright: String,
    license: Option<(String, String)>,
    description: Option<String>,
    usage: String,
    alias: Vector<String>
) -> Hook

Creates new hook with all field

impl Hook

pub fn name<T: Into<String>>(self, name: T) -> Self

Sets name.

pub fn authors<T: Into<String>>(self, authors: T) -> Self

Sets authors.

pub fn copyright<T: Into<String>>(self, copyright: T) -> Self

Sets copyright.

pub fn usage<T: Into<String>>(self, usage: T) -> Self

Sets usage.

pub fn action(self, action: HookAction) -> Self

Sets action.

pub fn license(self, license: (String, String)) -> Self

Sets license.

pub fn description(self, description: String) -> Self

Sets description.

pub fn alias<T: Into<String>>(self, alias: T) -> Self

Add alias to this hook.

pub fn is(&self, name_or_alias: &str) -> bool

Beturns true if name_or_alias matches command's name or one of alias at leaast. name_or_aliasがコマンド名がエイリアスのうち少なくとも一つにマッチした場合trueを返す

Trait Implementations

impl Clone for Hook

fn clone(&self) -> Hook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Hook

fn default() -> Hook

Returns the "default value" for a type.