Skip to main content

SoftKeyProfile

Struct SoftKeyProfile 

Source
pub struct SoftKeyProfile { /* private fields */ }
Expand description

Ordered soft-key actions advertised for every known station key mode.

The protocol template remains the canonical 32-entry action catalog; these sets choose which catalog entries appear in each mode and in which order.

Implementations§

Source§

impl SoftKeyProfile

Source

pub const MAX_KEYS_PER_MODE: usize = 16

Maximum number of actions that one station key mode can advertise.

Source

pub fn new( sets: impl IntoIterator<Item = (KeyMode, Vec<SoftKey>)>, ) -> Result<Self, CodecError>

Builds and validates a complete profile.

Every known KeyMode must occur exactly once. Use Self::empty as a convenient base when only a few modes should expose actions.

Source

pub fn empty() -> Self

Source

pub fn built_in() -> Self

The wire-compatible profile used when a station has no configured override.

Source

pub fn actions(&self, mode: KeyMode) -> &[SoftKey]

Source

pub fn allows(&self, mode: KeyMode, action: SoftKey) -> bool

Source

pub fn valid_mask(&self, mode: KeyMode) -> u32

Returns the station bit mask enabling every configured action in mode.

Source

pub fn template_actions(&self) -> Vec<SoftKey>

Actions whose labels are needed in the station template. The built-in profile intentionally retains the historical complete catalog bytes.

Source

pub fn validate(&self) -> Result<(), CodecError>

Verifies completeness, per-mode limits, known values, and uniqueness.

Trait Implementations§

Source§

impl Clone for SoftKeyProfile

Source§

fn clone(&self) -> SoftKeyProfile

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 SoftKeyProfile

Source§

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

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

impl Default for SoftKeyProfile

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for SoftKeyProfile

Source§

impl PartialEq for SoftKeyProfile

Source§

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

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, <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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more