Enum ayaka_primitive::RawValue

pub enum RawValue {
    Unit,
    Bool(bool),
    Num(i64),
    Str(String),
}

The basic and only type used in scripts.

assert_eq!(serde_yaml::from_str::<RawValue>("~").unwrap(), RawValue::Unit);
assert_eq!(serde_yaml::from_str::<RawValue>("true").unwrap(), RawValue::Bool(true));
assert_eq!(serde_yaml::from_str::<RawValue>("123").unwrap(), RawValue::Num(123));
assert_eq!(serde_yaml::from_str::<RawValue>("\"hello\"").unwrap(), RawValue::Str("hello".to_string()));

Variants

Unit

The unit type. It is empty, just like None or [()] in Rust.

Bool(bool)

The boolean type.

Num(i64)

The number type. It’s i64.

Str(String)

The string type.

Implementations

impl RawValue

pub fn get_type(&self) -> ValueType

Gets ValueType.

pub fn get_bool(&self) -> bool

Gets a boolean from the value:

• A RawValue::Unit converts to false.
• A RawValue::Num converts to false if and only if it’s zero.
• A RawValue::Str converts to false if and only if it’s empty.

let unit_value = RawValue::Unit;
assert!(!unit_value.get_bool());
let num_value = RawValue::Num(123);
assert!(num_value.get_bool());
let str_value = RawValue::Str("hello".to_string());
assert!(str_value.get_bool());
let empty_str_value = RawValue::Str(String::default());
assert!(!empty_str_value.get_bool());

pub fn get_num(&self) -> i64

Gets a number from the value:

• A RawValue::Unit converts to 0.
• A RawValue::Bool converts false to 0 and true to 1.
• A RawValue::Str converts to the length of the string.

let unit_value = RawValue::Unit;
assert_eq!(unit_value.get_num(), 0);
let bool_value = RawValue::Bool(true);
assert_eq!(bool_value.get_num(), 1);
let str_value = RawValue::Str("hello".to_string());
assert_eq!(str_value.get_num(), 5);

pub fn get_str(&self) -> Cow<'_, str>

Gets a string from the value:

• A RawValue::Unit converts to empty string.
• A RawValue::Bool converts to “false” or “true”.
• A RawValue::Num converts to the string representation of the number.

Be careful to use get_str().into_owned(), if possible, use into_str() instead.

let unit_value = RawValue::Unit;
assert_eq!(unit_value.get_str(), "");
let bool_value = RawValue::Bool(true);
assert_eq!(bool_value.get_str(), "true");
let num_value = RawValue::Num(123);
assert_eq!(num_value.get_str(), "123");

pub fn into_str(self) -> String

Gets a string from the value:

• A RawValue::Unit converts to empty string.
• A RawValue::Bool converts to “false” or “true”.
• A RawValue::Num converts to the string representation of the number.

Trait Implementations

impl Clone for RawValue

fn clone(&self) -> RawValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawValue

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

Formats the value using the given formatter.

impl Default for RawValue

fn default() -> RawValue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RawValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RawValue

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RawValue

fn cmp(&self, other: &RawValue) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RawValue

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

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

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

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

impl PartialOrd for RawValue

fn partial_cmp(&self, other: &RawValue) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RawValue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RawValue

impl StructuralEq for RawValue

impl StructuralPartialEq for RawValue