Skip to main content

DeviceActionDecl

Struct DeviceActionDecl 

Source
pub struct DeviceActionDecl {
    pub id: String,
    pub name: String,
    pub description: String,
    pub keystroke: KeystrokeDecl,
    pub prerequisite: Option<String>,
}
Expand description

One device-resolved action, owned. Mirrors DeviceAction.

Deliberately not an ActionDecl with extra fields. It carries no trigger, because a keystroke has no position to send, and no params, because a resolved binding stores none — so the two combinations ADR-0021 calls impossible have nowhere to live rather than being checked for. A reader of a log can also tell which kind they are looking at without checking a flag.

Serde ignores fields it was not asked about, so a hand-written JSON addon can still write "trigger" beside one of these. What it cannot do is make it mean anything, because nothing reads it. That is the accurate claim; “unrepresentable” would be too strong.

Fields§

§id: String

Stable identifier, stored as the binding’s provenance. Shares one namespace with ActionDecl::id; the daemon refuses a collision by name rather than resolving it to whichever list it looked in first.

§name: String

What to call it.

§description: String

What it does, in a sentence.

§keystroke: KeystrokeDecl

The default the binding editor starts from, which the user may change.

§prerequisite: Option<String>

The step outside Nobble the user must also take (FR-024), if any. Free text, shown at the moment of binding, and never parsed.

Trait Implementations§

Source§

impl Clone for DeviceActionDecl

Source§

fn clone(&self) -> DeviceActionDecl

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DeviceActionDecl

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DeviceActionDecl

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DeviceActionDecl

Source§

fn eq(&self, other: &DeviceActionDecl) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for DeviceActionDecl

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for DeviceActionDecl

Source§

impl StructuralPartialEq for DeviceActionDecl

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,