Skip to main content

ParamSpec

Struct ParamSpec 

Source
#[non_exhaustive]
pub struct ParamSpec { pub name: &'static str, pub kind: ParamKind, pub sensitive: bool, pub description: &'static str, pub file_key: Option<&'static str>, }
Expand description

One parameter a device declares (#125).

Fields (Non-exhaustive)§

This struct is marked as 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.
§name: &'static str

The name a change addresses, unique within its group — and the key the startup TOML spells it under, so a bound is written once.

§kind: ParamKind

What values it accepts.

§sensitive: bool

Write-only: never read back, published, logged or evented. A PIN, a key. It appears in the schema and never with a value.

§description: &'static str

One line for the operator reading the schema cold.

§file_key: Option<&'static str>

The key the startup file spells it under, when that is not name: a dotted path into the device’s section (duty_budget.fraction). The driver reads the file and the device never sees it; this is how the read-back says a value came from the file (#125).

Implementations§

Source§

impl ParamSpec

Source

pub const fn new( name: &'static str, kind: ParamKind, description: &'static str, ) -> Self

A parameter of the given kind.

Source

pub const fn sensitive(self) -> Self

Mark the parameter write-only.

Source

pub const fn file_key(self, key: &'static str) -> Self

The startup file’s key for it, when that is not the name.

Source

pub fn key_in_file(&self) -> &str

The startup file’s key for it.

Source

pub fn check(&self, value: &ConfigValue) -> Result<(), String>

Whether value is one this parameter accepts: the kind, and the bounds — with the bound named.

Trait Implementations§

Source§

impl Clone for ParamSpec

Source§

fn clone(&self) -> Self

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 ParamSpec

Source§

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

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

impl Eq for ParamSpec

Source§

impl PartialEq for ParamSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ParamSpec

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.