Enum cacao::defaults::Value

pub enum Value {
    Bool(bool),
    String(String),
    Float(f64),
    Integer(i64),
    Data(Vec<u8>),
}

Represents a Value that can be stored or queried with UserDefaults.

In general, this wraps a few types that should hopefully work for most cases. Note that the Value always owns whatever it holds - this is both for ergonomic considerations, as well as contractual obligations with the underlying NSUserDefaults system.

Variants

Bool(bool)

Represents a Boolean value.

String(String)

Represents a String value.

Float(f64)

Represents a Float (f64) value.

Integer(i64)

Represents an Integer (i64) value.

Data(Vec<u8>)

Represents Data (bytes). You can use this to store arbitrary things that aren’t supported above. You’re responsible for moving things back and forth to the necessary types.

Implementations

impl Value

pub fn string<S: Into<String>>(value: S) -> Self

A handy initializer for Value::String.

pub fn is_boolean(&self) -> bool

Returns true if the value is a boolean value. Returns false otherwise.

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

If this is a Bool, it returns the associated bool. Returns None otherwise.

pub fn is_string(&self) -> bool

Returns true if the value is a string. Returns false otherwise.

pub fn as_str(&self) -> Option<&str>

If this is a String, it returns a &str. Returns None otherwise.

pub fn is_integer(&self) -> bool

Returns true if the value is a float. Returns false otherwise.

pub fn as_i32(&self) -> Option<i32>

If this is a int, returns it (i32). Returns None otherwise.

pub fn as_i64(&self) -> Option<i64>

If this is a int, returns it (i64). Returns None otherwise.

pub fn is_float(&self) -> bool

Returns true if the value is a float. Returns false otherwise.

pub fn as_f32(&self) -> Option<f32>

If this is a float, returns it (f32). Returns None otherwise.

pub fn as_f64(&self) -> Option<f64>

If this is a float, returns it (f64). Returns None otherwise.

pub fn is_data(&self) -> bool

Returns true if the value is data. Returns false otherwise.

pub fn as_data(&self) -> Option<&[u8]>

If this is data, returns it (&[u8]). If you need to own the underlying buffer, you can extract it yourself. Returns None if this is not Data.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl From<Value> for id

fn from(value: Value) -> Self

Shepherds Value types into NSObjects that can be stored in NSUserDefaults.

impl PartialEq<Value> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Value