Struct ActionRequest 

#[non_exhaustive]
pub struct ActionRequest {
    pub action: String,
    pub params: Value,
}

A dynamically-dispatched UniFi action: an action name matched against crate::capabilities::all_capabilities, plus its JSON parameters.

#[non_exhaustive]: unlike this crate’s other public types, this one is meant to be constructed by callers — use ActionRequest::new rather than a struct literal, so a future added field (e.g. a per-call timeout override) can default instead of being 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, e.g. "clients" or "official_list_devices".

params: Value

Action parameters. Shape depends on the action; see its crate::capabilities::Capability for the expected path/query/body.

Implementations

impl ActionRequest

pub fn new(action: impl Into<String>, params: Value) -> Self

Builds a request for action with params.

Trait Implementations

impl Clone for ActionRequest

fn clone(&self) -> ActionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionRequest

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

Formats the value using the given formatter.