Struct tuna::Float64

pub struct Float64 { /* private fields */ }

The definition of a float variable

Implementations

impl Float64

pub const fn new(
    category: &'static str,
    name: &'static str,
    default: f64,
    min: Option<f64>,
    max: Option<f64>
) -> Self

Define a new float variable that can be registered with tuna

pub fn register(&self)

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

pub fn read(&self) -> f64

Read the variable from tuna. This will automatically call register on a lookup miss, and return the default value.

pub fn write(&self, value: f64)

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

pub fn reset(&self)

Reset to the default value.

Trait Implementations

impl AsTuneable for Float64

type Result = f64

fn make_tuneable(&self) -> Tuneable

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

fn reset(tuneable: &mut Tuneable)

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

impl Clone for Float64

fn clone(&self) -> Float64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Float64

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

Formats the value using the given formatter.

impl Copy for Float64