Skip to main content

ParamKind

Enum ParamKind 

Source
#[non_exhaustive]
pub enum ParamKind { Text, App, }
Expand description

What a parameter holds, so an interface can offer the right editor.

A hint, not a storage type — every parameter is stored as a string (ADR-0012). Widening this is additive; a client that does not recognise a kind falls back to a text box and stays useful.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Text

Free text.

§

App

An application identity, in whatever form the foreground watcher reports. The interface can offer “the application you were just in” rather than asking someone to type an executable name from memory.

Implementations§

Source§

impl ParamKind

Source

pub const fn as_wire(self) -> &'static str

How it is spelled on a wire. See Trigger::as_wire for why this is here rather than at each end.

Exhaustive, and that is the point of putting it in this crate. This type is #[non_exhaustive], so every match on it outside the SDK must carry a wildcard — which is how nobble_rpc::param_kind_name came to have a ParamKind::Text | _ => "text" arm defending against a variant that cannot exist in a build that compiled. Here the wildcard is not required, so adding a kind fails to compile at the one site that has to decide what it is called.

Source

pub fn from_wire(s: &str) -> Option<Self>

Read one back, or None if this build has no name for it.

Unlike Trigger::from_wire, defaulting is the documented behaviour for a caller here: this type’s own note says widening it is additive and a client that does not recognise a kind should offer a text box and stay useful. The Option is still the honest return, because “I do not know this one” and “this one is text” are different facts and only the caller knows whether the difference matters to it.

Trait Implementations§

Source§

impl Clone for ParamKind

Source§

fn clone(&self) -> ParamKind

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 ParamKind

Source§

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

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

impl PartialEq for ParamKind

Source§

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

Source§

impl Eq for ParamKind

Source§

impl StructuralPartialEq for ParamKind

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.