Struct DataType 

pub struct DataType { /* private fields */ }

DataType is just a String defining what data type is being used

Implementations

impl DataType

pub fn valid(&self) -> Result<()>

Determine if a datatype specified in a flow is a valid datatype or not

Errors

Will return Err if self.string does not describe a valid DataType

pub fn is_array(&self) -> bool

Return if this datatype is an array or not

pub fn is_generic(&self) -> bool

Return true if this datatype is generic (not specified at compile time and can contain any other datatype) or not

pub fn array_type(&self) -> Option<DataType>

If an Array –> Return Option of the DataType the array holds If Generic –> Return Generic If not an Array –> Return None

pub fn type_array_order(&self) -> i32

Determine how deeply nested in arrays this DataType is. If not an array, returns 0

This is used at compile time by the compiler to determine the array order of an input or output

pub fn value_array_order(value: &Value) -> i32

Determine how deeply nested in arrays this serde_json::value::Value is. If not an array, returns 0

This is used at run time to determine the array order of an actual value being processed

pub fn compatible_types( from: &[DataType], to: &[DataType], from_subroute: &Route, ) -> Result<()>

For a set of output types to be compatible with a destination’s set of types ALL of the output_types must have a compatible input type, to guarantee that any of the valid types produced can be handled by the destination

Errors

Will return Err if the from or to arrays of DataType are empty, or if the types of the two IO are incompatible

Trait Implementations

impl Clone for DataType

fn clone(&self) -> DataType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataType

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

Formats the value using the given formatter.

impl Default for DataType

fn default() -> DataType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DataType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DataType

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

Formats the value using the given formatter.

impl Eq for DataType

impl From<&str> for DataType

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for DataType

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for DataType

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for DataType

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 DataType

fn cmp(&self, other: &DataType) -> 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,

Restrict a value to a certain interval.

impl PartialEq for DataType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DataType

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for DataType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DataType