Struct puff_rs::program::Program

pub struct Program { /* private fields */ }

A Puff Program that is responsible for parsing CLI arguments and starting the Runtime.

Implementations

impl Program

pub fn new<T: Into<Text>>(name: T) -> Self

Creates a Program with the specified name.

pub fn runtime_config(self, runtime_config: RuntimeConfig) -> Self

Override the current RuntimeConfig for this program.

pub fn author<T: Into<Text>>(self, author: T) -> Self

Specify the author.

pub fn version<T: Into<Text>>(self, version: T) -> Self

Specify the version.

pub fn about<T: Into<Text>>(self, about: T) -> Self

Specify what your program does.

pub fn after_help<T: Into<Text>>(self, after_help: T) -> Self

Specify text after the help text of the CLI prompt.

pub fn command<C: RunnableCommand>(self, command: C) -> Self

Adds a new command to be available to the Program.

pub fn run(self) -> ExitCode

Run the program, handle and log the error if it fails.

See Self::try_run for more information.

pub fn try_run(self) -> Result<ExitCode>

Tries to run the program and returns an Error if it fails.

This will parse the command line arguments, start a new runtime and blocks until the command finishes.