Struct Capability 

#[non_exhaustive]
pub struct Capability {
    pub action: String,
    pub title: String,
    pub source: ApiSourceFamily,
    pub method: Option<String>,
    pub path: Option<String>,
    pub mutating: bool,
    pub auth_scope: AuthScope,
    pub verification_mode: Option<String>,
}

One dispatchable UniFi action: its name, which API serves it, and (for non-hybrid actions) the method/path template to call.

#[non_exhaustive]: instances only ever come from all_capabilities/find_capability — nothing outside this crate constructs one via struct literal — so a future added field (e.g. a rate-limit hint) should not be a downstream semver break.

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.

action: String

Action name, as passed to crate::ActionRequest::action.

title: String

Human-readable summary, e.g. for listing available actions in a UI.

source: ApiSourceFamily

Which API this capability is served from.

method: Option<String>

HTTP method. None only for ApiSourceFamily::Hybrid entries, which resolve to another capability’s method at dispatch time.

path: Option<String>

Path template, e.g. /v1/sites/{siteId}. None only for ApiSourceFamily::Hybrid entries.

mutating: bool

Whether this action changes controller state.

auth_scope: AuthScope

Minimum caller permission required. Not enforced by this crate — see the note on AuthScope.

verification_mode: Option<String>

Provenance/confidence tag from the source inventory (e.g. "contract_ok", "legacy_alias"); informational only.

Trait Implementations

impl Clone for Capability

fn clone(&self) -> Capability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capability

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

Formats the value using the given formatter.

impl PartialEq for Capability

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

impl StructuralPartialEq for Capability