Struct ActionArgs 

pub struct ActionArgs { /* private fields */ }

Arguments for one invocation, already checked against the action’s declared parameters.

There is no way to build one except through bind or none, so an action’s builder never has to re-validate: if it holds an ActionArgs, every required parameter is present and every value has the declared type. That is what keeps a bad call from becoming a half-applied edit.

Implementations

impl ActionArgs

pub fn none() -> ActionArgs

The empty argument set — what a nullary action is invoked with.

pub fn bind( params: &[ActionParam], supplied: impl IntoIterator<Item = (String, ArgValue)>, ) -> Result<ActionArgs, ArgError>

Check supplied against params and bind it.

Fails on the first problem rather than accumulating: the caller has to fix them one at a time anyway, and a partial bind must never reach an action.

Errors

Returns the first missing, unknown, wrong-typed, or disallowed argument.

pub fn bind_json( params: &[ActionParam], supplied: &Map<String, Value>, ) -> Result<ActionArgs, ArgError>

Bind arguments that arrived as a JSON object — the shape a control socket delivers.

Errors

Returns ArgError when a JSON value is unrepresentable or the supplied arguments do not satisfy params.

pub fn text(&self, name: &str) -> Option<&str>

The text bound to name, if any.

pub fn integer(&self, name: &str) -> Option<i64>

The integer bound to name, if any.

pub fn array(&self, name: &str) -> Option<&[Value]>

The JSON array bound to name, if any.

pub fn number(&self, name: &str) -> Option<f64>

The number bound to name, if any. An integer argument widens, matching ArgValue::satisfies.

pub fn boolean(&self, name: &str) -> Option<bool>

The boolean bound to name, if any.

pub fn get(&self, name: &str) -> Option<&ArgValue>

The raw bound value, for a caller that wants to switch on the type.

pub fn is_empty(&self) -> bool

Whether anything is bound.

pub fn to_json(&self) -> Map<String, Value>

Every bound argument as JSON — the inverse of bind_json, so a caller can echo back exactly what it sent.

Trait Implementations

impl Clone for ActionArgs

fn clone(&self) -> ActionArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionArgs

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

Formats the value using the given formatter.

impl Default for ActionArgs

fn default() -> ActionArgs

Returns the “default value” for a type.

impl PartialEq for ActionArgs

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