[−][src]Struct bird_tool_utils_man::Manual
The main man page struct.
Implementations
impl Manual
[src]
pub fn new(name: &str) -> Self
[src]
Create a new instance.
pub fn about<S: Into<String>>(self, about: S) -> Self
[src]
Add a short description.
pub fn description<S: Into<String>>(self, description: S) -> Self
[src]
Add a long description.
pub fn author(self, author: Author) -> Self
[src]
Add an author.
pub fn env(self, env: Env) -> Self
[src]
Add an environment variable.
pub fn flag(self, flag: Flag) -> Self
[src]
Add an flag.
pub fn option(self, opt: Opt) -> Self
[src]
Add an option.
pub fn custom(self, custom_section: Section) -> Self
[src]
Add a custom section
pub fn example(self, example: Example) -> Self
[src]
Add an examples section
pub fn arg(self, arg: Arg) -> Self
[src]
Add a positional argument. The items are displayed in the order they're pushed.
pub fn custom_synopsis_expansion<S: Into<String>>(self, expansion: S) -> Self
[src]
pub fn render(self) -> String
[src]
Render to a string.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Manual
impl !Send for Manual
impl !Sync for Manual
impl Unpin for Manual
impl !UnwindSafe for Manual
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,