Struct CommandAccess 

pub struct CommandAccess {
    pub visibility: CommandVisibility,
    pub runnable: CommandRunnable,
    pub reasons: Vec<AccessReason>,
    pub missing_capabilities: BTreeSet<String>,
}

Effective access decision for a command under a specific context.

Fields

visibility: CommandVisibility

Whether the command should be shown to the caller.

runnable: CommandRunnable

Whether the caller may execute the command.

reasons: Vec<AccessReason>

Reasons that explain why access was restricted.

missing_capabilities: BTreeSet<String>

Required capabilities absent from the current context.

Implementations

impl CommandAccess

pub fn visible_runnable() -> Self

Returns an access result that is visible and runnable.

pub fn hidden(reason: AccessReason) -> Self

Returns an access result that is hidden and denied for the given reason.

pub fn visible_denied(reason: AccessReason) -> Self

Returns an access result that is visible but denied for the given reason.

pub fn is_visible(&self) -> bool

Returns true when the command should be shown to the user.

pub fn is_runnable(&self) -> bool

Returns true when the command may be executed.

Trait Implementations

impl Clone for CommandAccess

fn clone(&self) -> CommandAccess

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandAccess

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

Formats the value using the given formatter.

impl PartialEq for CommandAccess

fn eq(&self, other: &CommandAccess) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CommandAccess

impl StructuralPartialEq for CommandAccess