Struct Described 

pub struct Described {
    pub what: Did,
    pub item: Option<ActionItem>,
}

What an action says about itself before it applies: what it does and to which item (crate::Action::describe).

Fields

what: Did

item: Option<ActionItem>

Implementations

impl Described

pub fn new(what: Did) -> Described

pub fn on(self, id: impl Into<String>, label: impl Into<String>) -> Described

pub fn of_published( encoded: &EncodedAction, key: ActionKey, ) -> Option<Described>

The published action key invoked with encoded: the verb with the plain arguments the encoded value carries. An empty key.app is filled by the executor from the entry’s app.

pub fn from_encoded( encoded: &EncodedAction, app: Option<&str>, ) -> Option<Described>

What an encoded action says about itself when its type describes nothing: the verb its serde variant names, with its plain arguments. app names the publishing app; without one the action type’s stem (notes of notes.action) stands in.

pub fn from_value( type_id: &str, value: &Value, app: Option<&str>, ) -> Option<Described>

Self::from_encoded for an action value already in JSON.

Trait Implementations

impl Clone for Described

fn clone(&self) -> Described

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Described

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Described

fn deserialize<__D>( __deserializer: __D, ) -> Result<Described, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Described

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Described

impl StructuralPartialEq for Described