Struct tuna::Boolean

pub struct Boolean { /* fields omitted */ }

The definition of a boolean variable

Implementations

impl Boolean

pub const fn new(
    category: &'static str,
    name: &'static str,
    default: bool
) -> Self

Define a new boolean variable that can be registered with tuna

pub fn register(&self)

Explicitly register the boolean with tuna. This is not required, but it’ll reduce risk of stuttering when variables get registered.

pub fn read(&self) -> Option<bool>

Read the variable from tuna. If the feature auto-register is enabled, will register on a lookup miss - otherwise it’ll just return the default value.

pub fn write(&self, value: bool)

Update the stored value. Will do nothing if not registered.

pub fn reset(&self)

Reset to the default value.

Trait Implementations

impl AsTuneable for Boolean

type Result = bool

fn make_tuneable(&self) -> Tuneable

fn update(tuneable: &mut Tuneable, var: bool)

fn reset(tuneable: &mut Tuneable)

fn from_tuneable(v: &Tuneable) -> Option<bool>

impl Clone for Boolean

fn clone(&self) -> Boolean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Boolean

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

Formats the value using the given formatter.

impl Copy for Boolean