Struct Params 

pub struct Params { /* private fields */ }

A set of named parameters.

Implementations

impl Params

pub fn declare(&mut self, name: impl Into<Name>, kind: ParamKind) -> ParamId

Declare name as kind and return its id; declaring an existing name again returns the existing id (the first kind wins).

pub fn id(&self, name: &str) -> Option<ParamId>

The id of name, if declared.

pub fn name(&self, id: ParamId) -> &str

The name of id.

pub fn kind(&self, id: ParamId) -> ParamKind

The kind of id.

pub fn set_bool(&mut self, id: ParamId, v: bool)

Set a bool parameter.

pub fn set_float(&mut self, id: ParamId, v: f32)

Set a float parameter.

pub fn fire(&mut self, id: ParamId)

Fire a trigger: pending for its time to live (re-firing restarts it).

pub fn get_bool(&self, id: ParamId) -> bool

A bool parameter’s value.

pub fn get_float(&self, id: ParamId) -> f32

A float parameter’s value.

pub fn pending(&self, id: ParamId) -> bool

Whether a trigger is pending.

pub fn iter(&self) -> impl Iterator<Item = (ParamId, &str, ParamKind, f32)>

Every parameter: id, name, kind and raw value (bools 0/1, triggers time left).

Trait Implementations

impl Clone for Params

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Params

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Params