Struct CommandPolicyOverride 

#[non_exhaustive]
pub struct CommandPolicyOverride {
    pub visibility: Option<VisibilityMode>,
    pub availability: Option<CommandAvailability>,
    pub required_capabilities: BTreeSet<String>,
    pub hidden_reason: Option<String>,
    pub denied_message: Option<String>,
}

Partial override applied on top of a registered CommandPolicy.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

visibility: Option<VisibilityMode>

Replacement visibility mode, when overridden.

availability: Option<CommandAvailability>

Replacement availability state, when overridden.

required_capabilities: BTreeSet<String>

Additional required capabilities merged into the base policy.

hidden_reason: Option<String>

Replacement hidden-reason metadata, when overridden.

denied_message: Option<String>

Replacement denial message, when overridden.

Implementations

impl CommandPolicyOverride

pub fn new() -> Self

Creates an empty override.

Examples

use osp_cli::core::command_policy::{
    CommandAvailability, CommandPolicyOverride, VisibilityMode,
};

let override_policy = CommandPolicyOverride::new()
    .with_visibility(Some(VisibilityMode::CapabilityGated))
    .with_availability(Some(CommandAvailability::Disabled))
    .with_required_capabilities([" Orch.Policy.Write ", ""]);

assert_eq!(
    override_policy.visibility,
    Some(VisibilityMode::CapabilityGated)
);
assert_eq!(
    override_policy.availability,
    Some(CommandAvailability::Disabled)
);
assert!(override_policy.required_capabilities.contains("orch.policy.write"));

pub fn with_visibility(self, visibility: Option<VisibilityMode>) -> Self

Replaces the overridden visibility mode.

pub fn with_availability( self, availability: Option<CommandAvailability>, ) -> Self

Replaces the overridden availability state.

pub fn with_required_capabilities<I, S>(self, required_capabilities: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the merged required-capability set with normalized values.

pub fn with_hidden_reason(self, hidden_reason: Option<String>) -> Self

Replaces the optional hidden-reason metadata.

pub fn with_denied_message(self, denied_message: Option<String>) -> Self

Replaces the optional denial message.

Trait Implementations

impl Clone for CommandPolicyOverride

fn clone(&self) -> CommandPolicyOverride

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandPolicyOverride

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

Formats the value using the given formatter.

impl Default for CommandPolicyOverride

fn default() -> CommandPolicyOverride

Returns the “default value” for a type.

impl PartialEq for CommandPolicyOverride

fn eq(&self, other: &CommandPolicyOverride) -> 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 CommandPolicyOverride

impl StructuralPartialEq for CommandPolicyOverride