Struct polyvalue::Value

source ·

pub struct Value { /* private fields */ }

Expand description

Main value type This is an enum that can hold any of the supported value types

Implementations§

source §

impl Value

source

pub fn new(inner: InnerValue) -> Self

Creates a new value from the given inner value

source

pub fn into_inner(self) -> InnerValue

Consumes the value and returns the inner value

source

pub fn inner(&self) -> &InnerValue

Returns a reference to the inner value

source

pub fn inner_mut(&mut self) -> &mut InnerValue

Returns a mutable reference to the inner value

source

pub fn set_flag(&mut self, flag: u8)

Set a flag on the value

source

pub fn clear_flag(&mut self, flag: u8)

Clears the given flag

source

pub fn has_flag(&self, flag: u8) -> bool

Returns true if the value has the given flag

source

pub fn serialize_tagged(self) -> Result<String, Error>

Serializes the value to a tagged value This is useful for serialization, as it will preserve the type of integers

source

pub fn deserialize_tagged(value: &str) -> Result<Self, Error>

Deserializes a tagged value

source

pub fn bool(inner: impl Into<Bool>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn u8(inner: impl Into<U8>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn i8(inner: impl Into<I8>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn u16(inner: impl Into<U16>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn i16(inner: impl Into<I16>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn u32(inner: impl Into<U32>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn i32(inner: impl Into<I32>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn u64(inner: impl Into<U64>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn i64(inner: impl Into<I64>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn float(inner: impl Into<Float>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn fixed(inner: impl Into<Fixed>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn currency(inner: impl Into<Currency>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn string(inner: impl Into<Str>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn range(inner: impl Into<Range>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn array(inner: impl Into<Array>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn object(inner: impl Into<Object>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn int(inner: impl Into<I64>) -> Self

Creates a new value from the given inner value Use with the types defined in crate::types

source

pub fn resolve(self, other: Self) -> Result<(Value, Value), Error>

Resolves the type of two values based on a priority system. If successful, both returned values are guaranteed to be of the same type

Consumes both values

For details on type resolution, see Value::type_for_comparison

§Example

use polyvalue::Value;
use polyvalue::ValueType;

let a = Value::from(1.0);
let b = Value::from(2);
let (a, b) = a.resolve(b).expect("Could not resolve types");
assert!(a.own_type() == ValueType::Float);
assert!(b.own_type() == ValueType::Float);

source

pub fn own_type(&self) -> ValueType

Returns the type of the value

§Example

use polyvalue::Value;
use polyvalue::ValueType;

let value = Value::from(1.0);
assert!(value.own_type() == ValueType::Float);

source

pub fn either_type(&self, other: &Self, match_on: ValueType) -> bool

returns true if either value is of the given type

§Example

use polyvalue::Value;
use polyvalue::ValueType;

let a = Value::from(1.0);
let b = Value::from(2);
assert!(a.either_type(&b, ValueType::Float));

source

pub fn as_a<T>(self) -> Result<T, Error>
where Self: TryInto<T, Error = Error>,

Resolves a value to the given type Use with the types defined in crate::types

Useful for enforcing a specific type, when you still wish to allow type-cooersion Float to Int, for example

§Example

use polyvalue::Value;
use polyvalue::types::I64;

let value = Value::from(1.0);
let int = value.as_a::<I64>().expect("Value could not be converted to int!");

source

pub fn if_is_a<T>(&self, type_name: ValueType) -> Option<T>
where Self: TryInto<T, Error = Error>,

Resolves a value to the given type, if the type matches a condition Use with the types defined in crate::types Returns None if the type does not match

§Example

use polyvalue::{ValueType, Value};

let value = Value::from(1.0);
if let Some(value) = value.if_is_a::<i64>(ValueType::Numeric) {
   println!("Value is a number: {}", value);
}

source

pub fn is_a(&self, type_name: ValueType) -> bool

Returns true if the value is of the given type Use with the ValueType enum

§Example

use polyvalue::Value;
use polyvalue::ValueType;

let value = Value::from(1.0);
assert!(!value.is_a(ValueType::Int));

source

pub fn as_type(self, type_name: ValueType) -> Result<Value, Error>

Resolves a value to the given type Will fail if the value cannot be converted to the given type,

For virtual types, the highest-priority match will be used For any, the input value will be returned For numeric, the value will be converted to fixed For collection, the value will be converted to object

Similar to Value::as_a, but for type names in the ValueType enum intead of types in the crate::types module

§Example

use polyvalue::Value;
use polyvalue::ValueType;

let value = Value::from(1.0);
let int = value.as_type(ValueType::Int).expect("Value could not be converted to int!");

source

pub fn type_for_comparison(&self, other: &Self) -> ValueType

Resolves the type of two values based on a priority system in order to determine how 2 values should be compared

The priority system is designed to prevent loss of information when comparing values of different types For example, Object -> Array would lose information on non-numeric keys Wheres Array -> Object would not

If both values are the same type, return that type Otherwise, cooerce both values to the same type using the order of priority:

Object
Array
String
Currency
Fixed
Float
Int
Bool

source

pub fn is_truthy(&self) -> bool

Returns true if the value is truthy This is a convenience method for boolean values

source

pub fn len(&self) -> usize

Returns the length of the value For strings, this is the length of the string in characters For collection types, this is the number of elements For everything else, this is 1 (the length of the array it would resolve to)

source

pub fn to_json_string(&self) -> String

Returns the value as a JSON string Returned value should be valid JSON

source

pub fn weak_equality(self, other: Self) -> Result<bool, Error>

Compares two values, ignoring type Consumes both values

source

pub fn weak_ord(self, other: Self) -> Result<Ordering, Error>

Compares two values, ignoring type Consumes both values

Trait Implementations§

source §

impl ArithmeticOperationExt for Value

source §

fn arithmetic_op( self, right: Self, operation: ArithmeticOperation ) -> Result<Self, Error>

Perform an arithmetic operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned Read more

source §

fn arithmetic_neg(self) -> Result<Self, Error>
where Self: Sized,

Perform an arithmetic negation on a value This is equivalent to arithmetic_op with ArithmeticOperation::Negate but is provided for convenience Read more

source §

impl BitwiseOperationExt for Value

source §

fn bitwise_op( self, right: Self, operation: BitwiseOperation ) -> Result<Self, Error>

Perform a bitwise operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned Read more

source §

fn bitwise_not(self) -> Result<Self, Error>
where Self: Sized,

Perform a bitwise not on a value This is equivalent to bitwise_op with BitwiseOperation::Not but is provided for convenience Read more

source §

impl BooleanOperationExt for Value

source §

fn boolean_op( self, right: Self, operation: BooleanOperation ) -> Result<Self, Error>

Perform a boolean operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned Read more

source §

fn boolean_not(self) -> Result<Value, Error>
where Self: Sized,

Perform a boolean not on a value This is equivalent to boolean_op with BooleanOperation::Not but is provided for convenience Read more

source §

impl Clone for Value

source §

fn clone(&self) -> Value

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

source §

impl Debug for Value

source §

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

Formats the value using the given formatter. Read more

source §

impl<'de> Deserialize<'de> for Value

source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source §

impl Display for Value

source §

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

Formats the value using the given formatter. Read more

source §