Struct Toggle 

pub struct Toggle { /* private fields */ }

A reactive boolean toggle.

Constructed via Toggle::new() (Lombok New). The initial value is the default (false); use set_true / set_false / toggle / set to change it. The current value is exposed as a Signal<bool> accessed through get_value(). Any html! body that reads toggle.get_value().get() inside its render closure re-renders when the value changes.

Toggle::default() produces the same value as Toggle::new().

Implementations

impl Toggle

Inherent implementation of Toggle.

pub fn set_true(&self)

Sets the value to true.

pub fn set_false(&self)

Sets the value to false.

pub fn toggle(&self)

Flips the value: true becomes false, false becomes true.

pub fn set(&self, next: bool)

Replaces the value with next.

Arguments

• bool - A boolean (bool).

pub fn get(&self) -> bool

Returns the current value as a snapshot.

Returns

• bool - The current value (or a snapshot thereof).

impl Toggle

pub fn get_value(&self) -> &Signal<bool>

pub fn get_mut_value(&mut self) -> &mut Signal<bool>

pub fn set_value(&mut self, val: Signal<bool>) -> &mut Self

impl Toggle

pub fn new() -> Self

Trait Implementations

impl Clone for Toggle

fn clone(&self) -> Toggle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Toggle

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

Formats the value using the given formatter.

impl Default for Toggle

fn default() -> Toggle

Returns the “default value” for a type.

impl Display for Toggle

Formatting / debug-printing for Toggle.

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult

Formats the Toggle via the supplied formatter.

Arguments

• &mut Formatter<'_> - The formatter receiving the formatted output.

Returns

• FmtResult - Result of the formatting operation.

impl PartialEq for Toggle

Equality comparison for Toggle.

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

Returns true when self and other are equivalent by the PartialEq contract.

Arguments

• &Self - The other value to compare against self.

Returns

• bool - true when self and other are equivalent by the trait contract.

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

Inequality operator !=.