Struct Knob 

pub struct Knob {
    pub name: String,
    pub value: f64,
    pub min: f64,
    pub max: f64,
    pub step: f64,
    pub choices: Vec<String>,
    pub shared: bool,
}

One build option of a component.

Fields

name: String

Label.

value: f64

Current value (for a choice: the index into choices).

min: f64

Smallest value.

max: f64

Largest value.

step: f64

Step of one key press.

choices: Vec<String>

Names of the values of a choice knob (empty for a numeric knob).

shared: bool

One setting for every module that has a shared knob of this name (DSig’s scheme and hash apply to its signer and its verifier alike): the TUI shows it once and sets it on all of them.

Implementations

impl Knob

Constructors and stepping for knobs.

pub fn range(name: &str, value: f64, min: f64, max: f64, step: f64) -> Knob

A numeric knob.

pub fn choice(name: &str, index: usize, choices: &[&str]) -> Knob

A choice knob.

pub fn shared(self) -> Knob

The same knob, marked shared.

pub fn show(&self) -> String

The value as text.

pub fn moved(&self, steps: f64) -> f64

value moved by steps steps (choices wrap around).

Trait Implementations

impl Clone for Knob

fn clone(&self) -> Knob

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Knob

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

Formats the value using the given formatter.

impl PartialEq for Knob

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Knob