Struct AuthRequest 

#[non_exhaustive]
pub struct AuthRequest<'a> { /* private fields */ }

Available on crate feature auth only.

The context passed to the auth hook: which command is being authorized.

Marked #[non_exhaustive] so future context (roles, the parsed arguments, …) can be added without a breaking change.

Examples

use cli_forge::{App, Command};

let mut app = App::new("demo").auth(|req| {
    // Only authorize `publish` when some session check passes.
    req.command() != "publish" || session_is_valid()
});
app.register(Command::new("publish").requires_auth(true).run(|_| { /* ... */ }));

fn session_is_valid() -> bool { true }

Implementations

impl<'a> AuthRequest<'a>

pub fn command(&self) -> &str

The name of the command being authorized (the last element of the path).

pub fn path(&self) -> &[&str]

The full command-name chain from the app root to this command, e.g. ["remote", "add"].