ValueType

Enum ValueType 

Source
pub enum ValueType {
    List(Box<ValueType>),
    Map(Box<ValueType>),
    Optional(Box<ValueType>),
    Primitive(PrimitiveType),
    Text,
    Custom,
}
Expand description

Represents value types (primitive or complex). Assumes that complex types will contain the same inner type and does not vary

Variants§

§

List(Box<ValueType>)

§

Map(Box<ValueType>)

§

Optional(Box<ValueType>)

§

Primitive(PrimitiveType)

§

Text

§

Custom

Implementations§

Source§

impl ValueType

Source

pub fn is_primitive_type(&self) -> bool

Source

pub fn to_primitive_type(&self) -> Option<PrimitiveType>

Source

pub fn from_type_name(name: &str) -> Result<Self, ParseError>

Constructs a value type from a Rust-based type string similar to what you would find from std::any::type_name

§Examples
use entity::{ValueType as VT, PrimitiveType as PVT, NumberType as NT};

assert_eq!(
    VT::from_type_name("u8").expect("one"),
    VT::Primitive(PVT::Number(NT::U8)),
);

assert_eq!(
    VT::from_type_name("std::vec::Vec<std::string::String>").expect("two"),
    VT::List(Box::from(VT::Text)),
);

assert_eq!(
    VT::from_type_name("Vec<Option<u8>>").expect("three"),
    VT::List(Box::from(VT::Optional(Box::from(VT::Primitive(PVT::Number(NT::U8)))))),
);

assert_eq!(
    VT::from_type_name("HashMap<String, u8>").expect("four"),
    VT::Map(Box::from(VT::Primitive(PVT::Number(NT::U8)))),
);

Trait Implementations§

Source§

impl Clone for ValueType

Source§

fn clone(&self) -> ValueType

Returns a duplicate 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 ValueType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ValueType

Source§

fn default() -> Self

Returns default value type of primitive unit

Source§

impl Display for ValueType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> From<&'a Value> for ValueType

Source§

fn from(v: &'a Value) -> Self

Produces the type of the referenced value by recursively iterating through complex types, assuming that the first value in types like list represent the entire set, defaulting to a primitive unit if a complex value does not have any items

Source§

impl From<NumberType> for ValueType

Source§

fn from(t: NumberType) -> Self

Converts number type (subclass of primitive type) to a value type

Source§

impl From<PrimitiveType> for ValueType

Source§

fn from(t: PrimitiveType) -> Self

Converts primitive value type to a value type

Source§

impl From<Value> for ValueType

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl FromStr for ValueType

Source§

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

Parses a string delimited by colons into a nested value type

§Examples
use entity::{ValueType as VT, PrimitiveType as PVT, NumberType as NT};
use strum::ParseError;
use std::str::FromStr;

assert_eq!(VT::from_str("char").unwrap(), VT::Primitive(PVT::Char));
assert_eq!(VT::from_str("u32").unwrap(), VT::Primitive(PVT::Number(NT::U32)));
assert_eq!(VT::from_str("number:u32").unwrap(), VT::Primitive(PVT::Number(NT::U32)));
assert_eq!(VT::from_str("primitive:number:u32").unwrap(), VT::Primitive(PVT::Number(NT::U32)));
assert_eq!(VT::from_str("list:u32").unwrap(), VT::List(Box::from(VT::Primitive(PVT::Number(NT::U32)))));
assert_eq!(VT::from_str("list:number:u32").unwrap(), VT::List(Box::from(VT::Primitive(PVT::Number(NT::U32)))));
assert_eq!(VT::from_str("list:primitive:number:u32").unwrap(), VT::List(Box::from(VT::Primitive(PVT::Number(NT::U32)))));
assert_eq!(VT::from_str("unknown").unwrap_err(), ParseError::VariantNotFound);
Source§

type Err = ParseError

The associated error which can be returned from parsing.
Source§

impl PartialEq for ValueType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ValueType

Source§

impl StructuralPartialEq for ValueType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts reference to Any
Source§

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

converts mutable reference to Any
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.