Struct aopt_help::AppHelp

pub struct AppHelp<'a, W> { /* private fields */ }

Implementations

impl<'a, W: Write> AppHelp<'a, W>

pub fn new<S: Into<Cow<'a, str>>>(
    name: S,
    head: S,
    foot: S,
    style: Style,
    writer: W
) -> Self

pub fn with_global<S: Into<Cow<'a, str>>>(self, name: S, head: S, foot: S) -> Self

Examples found in repository

src/lib.rs (line 72)

    pub fn new<S: Into<Cow<'a, str>>>(name: S, head: S, foot: S, style: Style, writer: W) -> Self {
        Self {
            writer,
            style,
            blocks: vec![],
            cmds: vec![],
            global: 0,
        }
        .with_global(name, head, foot)
    }

pub fn foot(&self) -> Cow<'a, str>

Examples found in repository

src/format/policy.rs (line 521)

    fn format(&self, app: &AppHelp<'a, W>) -> Option<Cow<'a, str>> {
        let usage = self.get_app_usage(app);
        let head = app.head();
        let foot = app.foot();
        let block_spacing = "\n".repeat(1 + app.style().block_spacing);
        let mut usages = if usage.is_empty() {
            vec![]
        } else {
            vec![usage]
        };

        if !head.is_empty() {
            usages.push(head);
        }
        for block in app.block().iter() {
            let block_help = self.get_block_help(block, app);

            if !block_help.is_empty() {
                usages.push(block_help);
            }
        }
        if self.show_global {
            for block in app.global().block() {
                let global_help = self.get_global_help(block, app.global(), app);

                if !global_help.is_empty() {
                    usages.push(global_help);
                }
            }
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        Some(usages.join(&block_spacing).into())
    }

pub fn head(&self) -> Cow<'a, str>

Examples found in repository

src/format/policy.rs (line 520)

    fn format(&self, app: &AppHelp<'a, W>) -> Option<Cow<'a, str>> {
        let usage = self.get_app_usage(app);
        let head = app.head();
        let foot = app.foot();
        let block_spacing = "\n".repeat(1 + app.style().block_spacing);
        let mut usages = if usage.is_empty() {
            vec![]
        } else {
            vec![usage]
        };

        if !head.is_empty() {
            usages.push(head);
        }
        for block in app.block().iter() {
            let block_help = self.get_block_help(block, app);

            if !block_help.is_empty() {
                usages.push(block_help);
            }
        }
        if self.show_global {
            for block in app.global().block() {
                let global_help = self.get_global_help(block, app.global(), app);

                if !global_help.is_empty() {
                    usages.push(global_help);
                }
            }
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        Some(usages.join(&block_spacing).into())
    }

pub fn name(&self) -> Cow<'a, str>

Examples found in repository

src/lib.rs (line 291)

    pub fn display_cmd<S>(&mut self, cmd: S) -> Result<()>
    where
        S: Into<Cow<'a, str>>,
    {
        let name = cmd.into();
        let cmd = self.cmds.iter().find(|v| v.name() == name).ok_or_else(|| {
            Error::raise(format!("Can not format help of {name} with DefaultPolicy"))
        })?;
        let policy = DefaultPolicy::new(self.name(), self.style.clone(), vec![], true);
        let help = policy.format(cmd).ok_or_else(|| todo!())?;

        writeln!(&mut self.writer, "{}", help)
            .map_err(|e| Error::raise(format!("Can not write to handler: {:?}", e)))
    }

pub fn style(&self) -> &Style

Examples found in repository

src/format/policy.rs (line 369)

    pub fn get_block_help(
        &self,
        block: &Block<'a, Cow<'a, str>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let head = block.head();
        let foot = block.foot();
        let count = block.len();
        let mut data = vec![vec![]; count];
        let styles = &self.styles;
        let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
        let mut any_filled = false;

        if block.is_empty() {
            return "".into();
        }
        for (name, data_mut) in block.iter().zip(data.iter_mut()) {
            if let Some(command) = app.find_cmd(name.clone()) {
                let hint = command.hint();
                let help = command.help();

                if !hint.is_empty() {
                    data_mut.push(hint);
                    any_filled = true;
                }
                if !help.is_empty() {
                    data_mut.push(help);
                    any_filled = true;
                }
            } else {
                panic!("Unknow command {} in block {}", name, block.name());
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }

        if !wrapped_lines.is_empty() {
            // pop last line spacing
            wrapped_lines.last_mut().unwrap().pop();
        }

        let mut usages = vec![];
        let wrapped_output = wrapped_lines.join("");

        if !head.is_empty() {
            usages.push(head);
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        if !wrapped_output.is_empty() {
            usages.push(wrapped_output.into());
        }

        usages.join(line_spacing).into()
    }

    pub fn get_global_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let style = &app.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;

        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                    }
                }
            }
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }
}

impl<'a, W: Write> HelpPolicy<'a, AppHelp<'a, W>> for DefaultAppPolicy<'a, AppHelp<'a, W>> {
    fn format(&self, app: &AppHelp<'a, W>) -> Option<Cow<'a, str>> {
        let usage = self.get_app_usage(app);
        let head = app.head();
        let foot = app.foot();
        let block_spacing = "\n".repeat(1 + app.style().block_spacing);
        let mut usages = if usage.is_empty() {
            vec![]
        } else {
            vec![usage]
        };

        if !head.is_empty() {
            usages.push(head);
        }
        for block in app.block().iter() {
            let block_help = self.get_block_help(block, app);

            if !block_help.is_empty() {
                usages.push(block_help);
            }
        }
        if self.show_global {
            for block in app.global().block() {
                let global_help = self.get_global_help(block, app.global(), app);

                if !global_help.is_empty() {
                    usages.push(global_help);
                }
            }
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        Some(usages.join(&block_spacing).into())
    }

pub fn global(&self) -> &Command<'a>

Examples found in repository

src/lib.rs (line 89)

    pub fn foot(&self) -> Cow<'a, str> {
        self.global().foot()
    }

    pub fn head(&self) -> Cow<'a, str> {
        self.global().head()
    }

    pub fn name(&self) -> Cow<'a, str> {
        self.global().name()
    }

src/format/policy.rs (line 302)

    pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
        let global = app.global();
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in global.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, global);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in global.block() {
            let arg = block.hint();

            if !arg.is_empty() {
                block_hint.push(arg);
            }
        }

        // all the option usage
        let global_usage = usages.join(" ");
        // all the args usage, hiding in default
        let args = if self.hiding_pos {
            "".to_owned()
        } else {
            args.join(" ")
        };
        let usage_space = if global_usage.is_empty() { "" } else { " " };
        let block_hint = block_hint.join(" ");
        let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };

        let ret = if self.hiding_pos {
            format!(
                "Usage: {}{usage_space}{} {} {}",
                global.name(),
                global_usage,
                command_usage,
                block_hint
            )
        } else {
            format!(
                "Usage: {}{usage_space}{} {} {}",
                global.name(),
                global_usage,
                command_usage,
                args
            )
        };

        ret.into()
    }

    pub fn get_block_help(
        &self,
        block: &Block<'a, Cow<'a, str>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let head = block.head();
        let foot = block.foot();
        let count = block.len();
        let mut data = vec![vec![]; count];
        let styles = &self.styles;
        let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
        let mut any_filled = false;

        if block.is_empty() {
            return "".into();
        }
        for (name, data_mut) in block.iter().zip(data.iter_mut()) {
            if let Some(command) = app.find_cmd(name.clone()) {
                let hint = command.hint();
                let help = command.help();

                if !hint.is_empty() {
                    data_mut.push(hint);
                    any_filled = true;
                }
                if !help.is_empty() {
                    data_mut.push(help);
                    any_filled = true;
                }
            } else {
                panic!("Unknow command {} in block {}", name, block.name());
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }

        if !wrapped_lines.is_empty() {
            // pop last line spacing
            wrapped_lines.last_mut().unwrap().pop();
        }

        let mut usages = vec![];
        let wrapped_output = wrapped_lines.join("");

        if !head.is_empty() {
            usages.push(head);
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        if !wrapped_output.is_empty() {
            usages.push(wrapped_output.into());
        }

        usages.join(line_spacing).into()
    }

    pub fn get_global_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let style = &app.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;

        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                    }
                }
            }
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }
}

impl<'a, W: Write> HelpPolicy<'a, AppHelp<'a, W>> for DefaultAppPolicy<'a, AppHelp<'a, W>> {
    fn format(&self, app: &AppHelp<'a, W>) -> Option<Cow<'a, str>> {
        let usage = self.get_app_usage(app);
        let head = app.head();
        let foot = app.foot();
        let block_spacing = "\n".repeat(1 + app.style().block_spacing);
        let mut usages = if usage.is_empty() {
            vec![]
        } else {
            vec![usage]
        };

        if !head.is_empty() {
            usages.push(head);
        }
        for block in app.block().iter() {
            let block_help = self.get_block_help(block, app);

            if !block_help.is_empty() {
                usages.push(block_help);
            }
        }
        if self.show_global {
            for block in app.global().block() {
                let global_help = self.get_global_help(block, app.global(), app);

                if !global_help.is_empty() {
                    usages.push(global_help);
                }
            }
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        Some(usages.join(&block_spacing).into())
    }

pub fn global_mut(&mut self) -> &mut Command<'a>

Examples found in repository

src/lib.rs (line 158)

    pub fn with_name<S: Into<Cow<'a, str>>>(mut self, name: S) -> Self {
        self.global_mut().set_name(name);
        self
    }

    pub fn with_head<S: Into<Cow<'a, str>>>(mut self, head: S) -> Self {
        self.global_mut().set_head(head);
        self
    }

    pub fn with_foot<S: Into<Cow<'a, str>>>(mut self, foot: S) -> Self {
        self.global_mut().set_foot(foot);
        self
    }

    pub fn with_style(mut self, style: Style) -> Self {
        self.style = style;
        self
    }

    pub fn with_writer(mut self, writer: W) -> Self {
        self.writer = writer;
        self
    }

    pub fn set_name<S: Into<Cow<'a, str>>>(&mut self, name: S) -> &mut Self {
        self.global_mut().set_name(name);
        self
    }

    pub fn set_head<S: Into<Cow<'a, str>>>(&mut self, head: S) -> &mut Self {
        self.global_mut().set_head(head);
        self
    }

    pub fn set_foot<S: Into<Cow<'a, str>>>(&mut self, foot: S) -> &mut Self {
        self.global_mut().set_foot(foot);
        self
    }

pub fn block(&self) -> &[Block<'a, Cow<'a, str>>]

Examples found in repository

src/format/policy.rs (line 532)

    fn format(&self, app: &AppHelp<'a, W>) -> Option<Cow<'a, str>> {
        let usage = self.get_app_usage(app);
        let head = app.head();
        let foot = app.foot();
        let block_spacing = "\n".repeat(1 + app.style().block_spacing);
        let mut usages = if usage.is_empty() {
            vec![]
        } else {
            vec![usage]
        };

        if !head.is_empty() {
            usages.push(head);
        }
        for block in app.block().iter() {
            let block_help = self.get_block_help(block, app);

            if !block_help.is_empty() {
                usages.push(block_help);
            }
        }
        if self.show_global {
            for block in app.global().block() {
                let global_help = self.get_global_help(block, app.global(), app);

                if !global_help.is_empty() {
                    usages.push(global_help);
                }
            }
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        Some(usages.join(&block_spacing).into())
    }

pub fn block_mut(&mut self) -> &mut [Block<'a, Cow<'a, str>>]

pub fn has_cmd(&self) -> bool

If the app has command except global one.

Examples found in repository

src/format/policy.rs (line 336)

    pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
        let global = app.global();
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in global.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, global);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in global.block() {
            let arg = block.hint();

            if !arg.is_empty() {
                block_hint.push(arg);
            }
        }

        // all the option usage
        let global_usage = usages.join(" ");
        // all the args usage, hiding in default
        let args = if self.hiding_pos {
            "".to_owned()
        } else {
            args.join(" ")
        };
        let usage_space = if global_usage.is_empty() { "" } else { " " };
        let block_hint = block_hint.join(" ");
        let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };

        let ret = if self.hiding_pos {
            format!(
                "Usage: {}{usage_space}{} {} {}",
                global.name(),
                global_usage,
                command_usage,
                block_hint
            )
        } else {
            format!(
                "Usage: {}{usage_space}{} {} {}",
                global.name(),
                global_usage,
                command_usage,
                args
            )
        };

        ret.into()
    }

pub fn has_pos(&self) -> bool

If the app has position args in any command.

pub fn find_cmd<S: Into<Cow<'a, str>>>(&self, cmd: S) -> Option<&Command<'a>>

Examples found in repository

src/lib.rs (line 226)

    pub fn add_cmd<S: Into<Cow<'a, str>>>(
        &mut self,
        block: S,
        cmd: Command<'a>,
    ) -> Result<&mut Self> {
        let block = block.into();

        self.find_block_mut(block.clone())
            .ok_or_else(|| Error::InvalidBlockName(block.to_string()))?
            .push(cmd.name());
        if self.find_cmd(cmd.name()).is_some() {
            Err(Error::DuplicatedCommandName(cmd.name().to_string()))
        } else {
            self.cmds.push(cmd);
            Ok(self)
        }
    }

    pub fn new_block<S: Into<Cow<'a, str>>>(&mut self, name: S) -> Result<AddBlock2App<'a, '_>> {
        let name = name.into();

        if self.find_block(name.clone()).is_some() {
            Err(Error::DuplicatedBlockName(name.to_string()))
        } else {
            Ok(AddBlock2App::new(&mut self.blocks, name))
        }
    }

    pub fn new_cmd<S: Into<Cow<'a, str>>>(
        &mut self,
        block: S,
        name: S,
    ) -> Result<AddCmd2App<'a, '_, W>> {
        let name = name.into();
        let block = block.into();

        self.find_block_mut(block.clone())
            .ok_or_else(|| Error::InvalidBlockName(block.to_string()))?;
        if self.find_cmd(name.clone()).is_some() {
            Err(Error::DuplicatedCommandName(name.to_string()))
        } else {
            Ok(AddCmd2App::new(self, block, name))
        }
    }

src/format/policy.rs (line 376)

    pub fn get_block_help(
        &self,
        block: &Block<'a, Cow<'a, str>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let head = block.head();
        let foot = block.foot();
        let count = block.len();
        let mut data = vec![vec![]; count];
        let styles = &self.styles;
        let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
        let mut any_filled = false;

        if block.is_empty() {
            return "".into();
        }
        for (name, data_mut) in block.iter().zip(data.iter_mut()) {
            if let Some(command) = app.find_cmd(name.clone()) {
                let hint = command.hint();
                let help = command.help();

                if !hint.is_empty() {
                    data_mut.push(hint);
                    any_filled = true;
                }
                if !help.is_empty() {
                    data_mut.push(help);
                    any_filled = true;
                }
            } else {
                panic!("Unknow command {} in block {}", name, block.name());
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }

        if !wrapped_lines.is_empty() {
            // pop last line spacing
            wrapped_lines.last_mut().unwrap().pop();
        }

        let mut usages = vec![];
        let wrapped_output = wrapped_lines.join("");

        if !head.is_empty() {
            usages.push(head);
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        if !wrapped_output.is_empty() {
            usages.push(wrapped_output.into());
        }

        usages.join(line_spacing).into()
    }

pub fn find_cmd_mut<S: Into<Cow<'a, str>>>(
    &mut self,
    cmd: S
) -> Option<&mut Command<'a>>

pub fn find_block<S: Into<Cow<'a, str>>>(
    &self,
    block: S
) -> Option<&Block<'a, Cow<'a, str>>>

Examples found in repository

src/lib.rs (line 208)

    pub fn add_block(&mut self, block: Block<'a, Cow<'a, str>>) -> Result<&mut Self> {
        if self.find_block(block.name()).is_some() {
            Err(Error::DuplicatedBlockName(block.name().to_string()))
        } else {
            self.blocks.push(block);
            Ok(self)
        }
    }

    pub fn add_cmd<S: Into<Cow<'a, str>>>(
        &mut self,
        block: S,
        cmd: Command<'a>,
    ) -> Result<&mut Self> {
        let block = block.into();

        self.find_block_mut(block.clone())
            .ok_or_else(|| Error::InvalidBlockName(block.to_string()))?
            .push(cmd.name());
        if self.find_cmd(cmd.name()).is_some() {
            Err(Error::DuplicatedCommandName(cmd.name().to_string()))
        } else {
            self.cmds.push(cmd);
            Ok(self)
        }
    }

    pub fn new_block<S: Into<Cow<'a, str>>>(&mut self, name: S) -> Result<AddBlock2App<'a, '_>> {
        let name = name.into();

        if self.find_block(name.clone()).is_some() {
            Err(Error::DuplicatedBlockName(name.to_string()))
        } else {
            Ok(AddBlock2App::new(&mut self.blocks, name))
        }
    }

pub fn find_block_mut<S: Into<Cow<'a, str>>>(
    &mut self,
    block: S
) -> Option<&mut Block<'a, Cow<'a, str>>>

Examples found in repository

src/lib.rs (line 223)

    pub fn add_cmd<S: Into<Cow<'a, str>>>(
        &mut self,
        block: S,
        cmd: Command<'a>,
    ) -> Result<&mut Self> {
        let block = block.into();

        self.find_block_mut(block.clone())
            .ok_or_else(|| Error::InvalidBlockName(block.to_string()))?
            .push(cmd.name());
        if self.find_cmd(cmd.name()).is_some() {
            Err(Error::DuplicatedCommandName(cmd.name().to_string()))
        } else {
            self.cmds.push(cmd);
            Ok(self)
        }
    }

    pub fn new_block<S: Into<Cow<'a, str>>>(&mut self, name: S) -> Result<AddBlock2App<'a, '_>> {
        let name = name.into();

        if self.find_block(name.clone()).is_some() {
            Err(Error::DuplicatedBlockName(name.to_string()))
        } else {
            Ok(AddBlock2App::new(&mut self.blocks, name))
        }
    }

    pub fn new_cmd<S: Into<Cow<'a, str>>>(
        &mut self,
        block: S,
        name: S,
    ) -> Result<AddCmd2App<'a, '_, W>> {
        let name = name.into();
        let block = block.into();

        self.find_block_mut(block.clone())
            .ok_or_else(|| Error::InvalidBlockName(block.to_string()))?;
        if self.find_cmd(name.clone()).is_some() {
            Err(Error::DuplicatedCommandName(name.to_string()))
        } else {
            Ok(AddCmd2App::new(self, block, name))
        }
    }

pub fn with_name<S: Into<Cow<'a, str>>>(self, name: S) -> Self

pub fn with_head<S: Into<Cow<'a, str>>>(self, head: S) -> Self

pub fn with_foot<S: Into<Cow<'a, str>>>(self, foot: S) -> Self

pub fn with_style(self, style: Style) -> Self

pub fn with_writer(self, writer: W) -> Self

pub fn set_name<S: Into<Cow<'a, str>>>(&mut self, name: S) -> &mut Self

pub fn set_head<S: Into<Cow<'a, str>>>(&mut self, head: S) -> &mut Self

pub fn set_foot<S: Into<Cow<'a, str>>>(&mut self, foot: S) -> &mut Self

pub fn set_style(&mut self, style: Style) -> &mut Self

pub fn set_write(&mut self, writer: W) -> &mut Self

pub fn add_block(&mut self, block: Block<'a, Cow<'a, str>>) -> Result<&mut Self>

pub fn add_cmd<S: Into<Cow<'a, str>>>(
    &mut self,
    block: S,
    cmd: Command<'a>
) -> Result<&mut Self>

Examples found in repository

src/lib.rs (line 516)

    pub fn submit(mut self) {
        if !self.added {
            let store = std::mem::take(&mut self.cmd);

            self.app.add_cmd(self.block.clone(), store).unwrap();
            self.added = true;
        }
    }
}

impl<'a, 'b, W: Write> Drop for AddCmd2App<'a, 'b, W> {
    fn drop(&mut self) {
        if !self.added {
            let store = std::mem::take(&mut self.cmd);

            self.app.add_cmd(self.block.clone(), store).unwrap();
            self.added = true;
        }
    }

pub fn new_block<S: Into<Cow<'a, str>>>(
    &mut self,
    name: S
) -> Result<AddBlock2App<'a, '_>>

pub fn new_cmd<S: Into<Cow<'a, str>>>(
    &mut self,
    block: S,
    name: S
) -> Result<AddCmd2App<'a, '_, W>>

pub fn display(&mut self, show_global: bool) -> Result<()>

pub fn display_with<P>(&mut self, policy: P) -> Result<()>where
    P: HelpPolicy<'a, Self>,

pub fn display_cmd<S>(&mut self, cmd: S) -> Result<()>where
    S: Into<Cow<'a, str>>,

pub fn display_cmd_with<S, P>(&mut self, cmd: S, policy: P) -> Result<()>where
    P: HelpPolicy<'a, Command<'a>>,
    S: Into<Cow<'a, str>>,

Trait Implementations

impl<'a, W: Clone> Clone for AppHelp<'a, W>

fn clone(&self) -> AppHelp<'a, W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, W: Debug> Debug for AppHelp<'a, W>

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

Formats the value using the given formatter.

impl<'a> Default for AppHelp<'a, Stdout>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, W: Write> HelpPolicy<'a, AppHelp<'a, W>> for DefaultAppPolicy<'a, AppHelp<'a, W>>

fn format(&self, app: &AppHelp<'a, W>) -> Option<Cow<'a, str>>