Enum preserves::value::repr::Value

pub enum Value<N: NestedValue> {
    Boolean(bool),
    Double(Double),
    SignedInteger(SignedInteger),
    String(String),
    ByteString(Vec<u8>),
    Symbol(String),
    Record(Record<N>),
    Sequence(Vec<N>),
    Set(Set<N>),
    Dictionary(Map<N, N>),
    Embedded(N::Embedded),
}

The Values from the specification.

Variants

Boolean(bool)

Double(Double)

SignedInteger(SignedInteger)

String(String)

ByteString(Vec<u8>)

Symbol(String)

Record(Record<N>)

Sequence(Vec<N>)

Set(Set<N>)

Dictionary(Map<N, N>)

Embedded(N::Embedded)

Implementations

impl<N: NestedValue> Value<N>

pub fn wrap(self) -> N

Converts self to a NestedValue by supplying an empty collection of annotations.

pub fn children(&self) -> Vec<N>

Retrieve a vector of the “children” of self.

For atoms, this is an empty vector. For records, it’s all the fields (but not the label). For sequences and sets, it’s the contained values. For dictionaries, it’s all the values in the key-value mappings (but not the keys).

pub fn is_boolean(&self) -> bool

True iff this is a Value::Boolean.

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

Yields Some iff this is a Value::Boolean.

pub fn as_boolean_mut(&mut self) -> Option<&mut bool>

Retrieve a mutable reference to the contained boolean value iff this is a Value::Boolean.

pub fn to_boolean(&self) -> Result<bool, Error>

Yields Ok iff this is a Value::Boolean; else Error::Expected.

pub fn is_double(&self) -> bool

True iff this is a Value::Double.

pub fn as_double(&self) -> Option<&Double>

Yields Some iff this is a Value::Double.

pub fn as_double_mut(&mut self) -> Option<&mut Double>

Retrieve a mutable reference to the contained Double value iff this is a Value::Double.

pub fn to_double(&self) -> Result<&Double, Error>

Yields Ok iff this is a Value::Double; else Error::Expected.

pub fn is_f64(&self) -> bool

As Self::is_double.

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

As Self::as_double, but yields f64 instead of Double.

pub fn as_f64_mut(&mut self) -> Option<&mut f64>

As Self::as_double_mut, but f64 instead of Double.

pub fn to_f64(&self) -> Result<f64, Error>

As Self::to_double, but with f64 instead of Double.

pub fn is_signedinteger(&self) -> bool

True iff this is a Value::SignedInteger.

pub fn as_signedinteger(&self) -> Option<&SignedInteger>

Yields Some iff this is a Value::SignedInteger.

pub fn as_signedinteger_mut(&mut self) -> Option<&mut SignedInteger>

Retrieve a mutable reference to the contained SignedInteger value iff this is a Value::SignedInteger.

pub fn to_signedinteger(&self) -> Result<&SignedInteger, Error>

Yields Ok iff this is a Value::SignedInteger; else Error::Expected.

pub fn is_i(&self) -> bool

True iff Self::as_i yields Some.

pub fn as_i(&self) -> Option<i128>

Yields Some if self is a Value::SignedInteger that fits in i128.

pub fn to_i(&self) -> Result<i128, Error>

Yields Ok if self is a Value::SignedInteger that fits in i128; else Error::Expected.

pub fn is_u(&self) -> bool

True iff Self::as_u yields Some.

pub fn as_u(&self) -> Option<u128>

Yields Some if self is a Value::SignedInteger that fits in u128.

pub fn to_u(&self) -> Result<u128, Error>

Yields Ok if self is a Value::SignedInteger that fits in u128; else Error::Expected.

pub fn as_u8(&self) -> Option<u8>

Yields Some if self is a Value::SignedInteger that fits in u8.

pub fn as_i8(&self) -> Option<i8>

Yields Some if self is a Value::SignedInteger that fits in i8.

pub fn as_u16(&self) -> Option<u16>

Yields Some if self is a Value::SignedInteger that fits in u16.

pub fn as_i16(&self) -> Option<i16>

Yields Some if self is a Value::SignedInteger that fits in i16.

pub fn as_u32(&self) -> Option<u32>

Yields Some if self is a Value::SignedInteger that fits in u32.

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

Yields Some if self is a Value::SignedInteger that fits in i32.

pub fn as_u64(&self) -> Option<u64>

Yields Some if self is a Value::SignedInteger that fits in u64.

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

Yields Some if self is a Value::SignedInteger that fits in i64.

pub fn as_u128(&self) -> Option<u128>

Yields Some if self is a Value::SignedInteger that fits in u128.

pub fn as_i128(&self) -> Option<i128>

Yields Some if self is a Value::SignedInteger that fits in i128.

pub fn as_usize(&self) -> Option<usize>

Yields Some if self is a Value::SignedInteger that fits in usize.

pub fn as_isize(&self) -> Option<isize>

Yields Some if self is a Value::SignedInteger that fits in isize.

pub fn to_i8(&self) -> Result<i8, Error>

Yields Ok if self is a Value::SignedInteger that fits in i8; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_u8(&self) -> Result<u8, Error>

Yields Ok if self is a Value::SignedInteger that fits in u8; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_i16(&self) -> Result<i16, Error>

Yields Ok if self is a Value::SignedInteger that fits in i16; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_u16(&self) -> Result<u16, Error>

Yields Ok if self is a Value::SignedInteger that fits in u16; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_i32(&self) -> Result<i32, Error>

Yields Ok if self is a Value::SignedInteger that fits in i32; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_u32(&self) -> Result<u32, Error>

Yields Ok if self is a Value::SignedInteger that fits in u32; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_i64(&self) -> Result<i64, Error>

Yields Ok if self is a Value::SignedInteger that fits in i64; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_u64(&self) -> Result<u64, Error>

Yields Ok if self is a Value::SignedInteger that fits in u64; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_i128(&self) -> Result<i128, Error>

Yields Ok if self is a Value::SignedInteger that fits in i128; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_u128(&self) -> Result<u128, Error>

Yields Ok if self is a Value::SignedInteger that fits in u128; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_isize(&self) -> Result<isize, Error>

Yields Ok if self is a Value::SignedInteger that fits in isize; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_usize(&self) -> Result<usize, Error>

Yields Ok if self is a Value::SignedInteger that fits in usize; otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn to_char(&self) -> Result<char, Error>

Yields Ok if self is a record with label a symbol UnicodeScalar and single field a SignedInteger that can represent a valid Unicode scalar value. Otherwise, Error::Expected or Error::InvalidUnicodeScalar. otherwise, Error::Expected or Error::NumberOutOfRange.

pub fn is_string(&self) -> bool

True iff this is a Value::String.

pub fn as_string(&self) -> Option<&String>

Yields Some iff this is a Value::String.

pub fn as_string_mut(&mut self) -> Option<&mut String>

Retrieve a mutable reference to the contained String value iff this is a Value::String.

pub fn into_string(self) -> Option<String>

Consumes self, yielding a String iff self is a Value::String.

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

Yields Ok iff this is a Value::String; else Error::Expected.

pub fn bytestring<'a, V: Into<Cow<'a, [u8]>>>(v: V) -> Self

Constructs a Value::ByteString from v.

pub fn is_bytestring(&self) -> bool

True iff this is a Value::ByteString.

pub fn as_bytestring(&self) -> Option<&Vec<u8>>

Yields Some iff this is a Value::ByteString.

pub fn as_bytestring_mut(&mut self) -> Option<&mut Vec<u8>>

Retrieve a mutable reference to the contained bytes value iff this is a Value::ByteString.

pub fn into_bytestring(self) -> Option<Vec<u8>>

Consumes self, yielding a Vec<u8> iff self is a Value::ByteString.

pub fn to_bytestring(&self) -> Result<&Vec<u8>, Error>

Yields Ok iff this is a Value::ByteString; else Error::Expected.

pub fn symbol(s: &str) -> Value<N>

Constructs a Value::Symbol from v.

pub fn is_symbol(&self) -> bool

True iff this is a Value::Symbol.

pub fn as_symbol(&self) -> Option<&String>

Yields Some iff this is a Value::Symbol.

pub fn as_symbol_mut(&mut self) -> Option<&mut String>

Retrieve a mutable reference to the contained Symbol’s string iff this is a Value::Symbol.

pub fn into_symbol(self) -> Option<String>

Consumes self, yielding a String iff self is a Value::Symbol.

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

Yields Ok iff this is a Value::Symbol; else Error::Expected.

pub fn record(label: N, expected_arity: usize) -> Record<N>

Constructs a record with the given label and expected arity. The new record will initially not have any fields, but will be allocated with capacity for expected_arity fields.

pub fn is_record(&self) -> bool

True iff this is a Value::Record.

pub fn as_record(&self, arity: Option<usize>) -> Option<&Record<N>>

Yields Some iff this is a Value::Record.

pub fn into_record(self) -> Option<Record<N>>

Consumes self, yielding a Record iff self is a Value::Record.

pub fn as_record_mut(&mut self, arity: Option<usize>) -> Option<&mut Record<N>>

Retrieve a mutable reference to the contained Record value iff this is a Value::Record.

pub fn to_record(&self, arity: Option<usize>) -> Result<&Record<N>, Error>

Yields Ok iff this is a Value::Record; else Error::Expected.

pub fn simple_record(label: &str, expected_arity: usize) -> Record<N>

Like Self::record, but for the common case where the label is to be a Symbol with a given text.

pub fn simple_record0(label: &str) -> Value<N>

Constructs a record with label a symbol with text label, and no fields.

pub fn simple_record1(label: &str, field: N) -> Value<N>

Constructs a record with label a symbol with text label, and one field.

pub fn is_simple_record(&self, label: &str, arity: Option<usize>) -> bool

True iff self is a record with label a symbol with text label and arity matching arity: any arity, if arity == None, or the specific usize concerned otherwise.

pub fn as_simple_record( &self, label: &str, arity: Option<usize> ) -> Option<&[N]>

Yields Some containing a reference to the record’s fields iff Self::is_simple_record(label, arity) returns true.

pub fn to_simple_record( &self, label: &str, arity: Option<usize> ) -> Result<&[N], Error>

Like Self::as_simple_record, but yields Error::Expected on failure.

pub fn to_option(&self) -> Result<Option<&N>, Error>

Serde’s “option” type is incoded in Preserves as <None> or <Some v>.

pub fn is_sequence(&self) -> bool

True iff this is a Value::Sequence.

pub fn as_sequence(&self) -> Option<&Vec<N>>

Yields Some iff this is a Value::Sequence.

pub fn into_sequence(self) -> Option<Vec<N>>

Consumes self, yielding a Vec<N> iff self is a Value::Sequence.

pub fn as_sequence_mut(&mut self) -> Option<&mut Vec<N>>

Retrieve a mutable reference to the contained Vec<N> iff this is a Value::Sequence.

pub fn to_sequence(&self) -> Result<&Vec<N>, Error>

Yields Ok iff this is a Value::Sequence; else Error::Expected.

pub fn is_set(&self) -> bool

True iff this is a Value::Set.

pub fn as_set(&self) -> Option<&Set<N>>

Yields Some iff this is a Value::Set.

pub fn into_set(self) -> Option<Set<N>>

Consumes self, yielding a Set<N> iff self is a Value::Set.

pub fn as_set_mut(&mut self) -> Option<&mut Set<N>>

Retrieve a mutable reference to the contained Set value iff this is a Value::Set.

pub fn to_set(&self) -> Result<&Set<N>, Error>

Yields Ok iff this is a Value::Set; else Error::Expected.

pub fn is_dictionary(&self) -> bool

True iff this is a Value::Dictionary.

pub fn as_dictionary(&self) -> Option<&Map<N, N>>

Yields Some iff this is a Value::Dictionary.

pub fn into_dictionary(self) -> Option<Map<N, N>>

Consumes self, yielding a Map<N, N> iff self is a Value::Dictionary.

pub fn as_dictionary_mut(&mut self) -> Option<&mut Map<N, N>>

Retrieve a mutable reference to the contained Map value iff this is a Value::Dictionary.

pub fn to_dictionary(&self) -> Result<&Map<N, N>, Error>

Yields Ok iff this is a Value::Dictionary; else Error::Expected.

pub fn is_embedded(&self) -> bool

True iff this is a Value::Embedded.

pub fn as_embedded(&self) -> Option<&N::Embedded>

Yields Some iff this is a Value::Embedded.

pub fn to_embedded(&self) -> Result<&N::Embedded, Error>

Yields Ok iff this is a Value::Embedded; else Error::Expected.

pub fn strip_annotations<M: NestedValue<Embedded = N::Embedded>>( &self ) -> Value<M>

Yields a deep copy of self with all annotations (recursively) removed.

pub fn copy_via<M: NestedValue, F, Err>( &self, f: &mut F ) -> Result<Value<M>, Err>

where F: FnMut(&N::Embedded) -> Result<Value<M>, Err>,

Yields a deep copy of self, mapping embedded values to a new type via f.

pub fn foreach_embedded<F, Err>(&self, f: &mut F) -> Result<(), Err>

where F: FnMut(&N::Embedded) -> Result<(), Err>,

Calls f once for each (recursively) embedded value in self.

Trait Implementations

impl<N: Clone + NestedValue> Clone for Value<N>

where N::Embedded: Clone,

fn clone(&self) -> Value<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: NestedValue> Debug for Value<N>

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

Formats the value using the given formatter.

impl<N: NestedValue> From<&[u8]> for Value<N>

fn from(v: &[u8]) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<&BigInt> for Value<N>

fn from(v: &BigInt) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<&Double> for Value<N>

fn from(v: &Double) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<&SignedInteger> for Value<N>

fn from(v: &SignedInteger) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<&String> for Value<N>

fn from(v: &String) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<&bool> for Value<N>

fn from(v: &bool) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<&f64> for Value<N>

fn from(v: &f64) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<&str> for Value<N>

fn from(v: &str) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<BTreeMap<N, N>> for Value<N>

fn from(v: Map<N, N>) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<BTreeSet<N>> for Value<N>

fn from(v: Set<N>) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<BigInt> for Value<N>

fn from(v: BigInt) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<String> for Value<N>

fn from(v: String) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<Vec<N>> for Value<N>

fn from(v: Vec<N>) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<bool> for Value<N>

fn from(v: bool) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<f64> for Value<N>

fn from(v: f64) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<i128> for Value<N>

fn from(v: i128) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<i16> for Value<N>

fn from(v: i16) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<i32> for Value<N>

fn from(v: i32) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<i64> for Value<N>

fn from(v: i64) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<i8> for Value<N>

fn from(v: i8) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<isize> for Value<N>

fn from(v: isize) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<u128> for Value<N>

fn from(v: u128) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<u16> for Value<N>

fn from(v: u16) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<u32> for Value<N>

fn from(v: u32) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<u64> for Value<N>

fn from(v: u64) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<u8> for Value<N>

fn from(v: u8) -> Self

Converts to this type from the input type.

impl<N: NestedValue> From<usize> for Value<N>

fn from(v: usize) -> Self

Converts to this type from the input type.

impl<Err: Into<Error>, D: Embeddable + FromStr<Err = Err>, N: NestedValue<Embedded = D>> FromStr for Value<N>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<N: Hash + NestedValue> Hash for Value<N>

where N::Embedded: Hash,

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<N: NestedValue> Index<&N> for Value<N>

type Output = N

The returned type after indexing.

fn index(&self, i: &N) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<N: NestedValue> Index<usize> for Value<N>

type Output = N

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<N: NestedValue> IndexMut<usize> for Value<N>

fn index_mut(&mut self, i: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<N: Ord + NestedValue> Ord for Value<N>

where N::Embedded: Ord,

fn cmp(&self, other: &Value<N>) -> 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<N: PartialEq + NestedValue> PartialEq for Value<N>

where N::Embedded: PartialEq,

fn eq(&self, other: &Value<N>) -> 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<N: PartialOrd + NestedValue> PartialOrd for Value<N>

where N::Embedded: PartialOrd,

fn partial_cmp(&self, other: &Value<N>) -> 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<N: Eq + NestedValue> Eq for Value<N>

where N::Embedded: Eq,

impl<N: NestedValue> StructuralPartialEq for Value<N>