Struct ControlMeta 

pub struct ControlMeta {
    pub id: ControlId,
    pub name: String,
    pub kind: ControlKind,
    pub access: Access,
    pub min: ControlValue,
    pub max: ControlValue,
    pub default: ControlValue,
    pub step: Option<ControlValue>,
    pub menu: Option<Vec<String>>,
}

Simplified control metadata.

Example

use styx_core::prelude::{Access, ControlId, ControlKind, ControlMeta, ControlValue};

let meta = ControlMeta {
    id: ControlId(1),
    name: "gain".into(),
    kind: ControlKind::Uint,
    access: Access::ReadWrite,
    min: ControlValue::Uint(0),
    max: ControlValue::Uint(255),
    default: ControlValue::Uint(16),
    step: Some(ControlValue::Uint(1)),
    menu: None,
};
assert!(meta.validate(&ControlValue::Uint(32)));

Fields

id: ControlId

Stable identifier.

name: String

Human-readable name.

kind: ControlKind

Kind of control/value type.

access: Access

Access permissions.

min: ControlValue

Minimum accepted value.

max: ControlValue

Maximum accepted value.

default: ControlValue

Default value.

step: Option<ControlValue>

Optional step size for ranged controls.

menu: Option<Vec<String>>

Optional enumerated menu entries (for menu controls).

Implementations

impl ControlMeta

pub fn validate(&self, candidate: &ControlValue) -> bool

Basic range validation respecting the variant.

Example

use styx_core::prelude::{Access, ControlId, ControlKind, ControlMeta, ControlValue};

let meta = ControlMeta {
    id: ControlId(1),
    name: "brightness".into(),
    kind: ControlKind::Int,
    access: Access::ReadWrite,
    min: ControlValue::Int(-10),
    max: ControlValue::Int(10),
    default: ControlValue::Int(0),
    step: Some(ControlValue::Int(1)),
    menu: None,
};
assert!(meta.validate(&ControlValue::Int(5)));

Trait Implementations

impl Clone for ControlMeta

fn clone(&self) -> ControlMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlMeta

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

Formats the value using the given formatter.