Enum Type 

pub enum Type {
    Any,
    Binary,
    Block,
    Bool,
    CellPath,
    Closure,
    Custom(Box<str>),
    Date,
    Duration,
    Error,
    Filesize,
    Float,
    Int,
    List(Box<Type>),
    Nothing,
    Number,
    OneOf(OneOf),
    Range,
    Record(CollectionColumns<Type>),
    String,
    Glob,
    Table(CollectionColumns<Type>),
}

Variants

Any

Top type, supertype of all types

Binary

Block

Bool

CellPath

Closure

Custom(Box<str>)

Date

Duration

Error

Filesize

Float

Int

List(Box<Type>)

Nothing

Number

Supertype of Int and Float. Equivalent to oneof<int, float>

OneOf(OneOf)

Supertype of all types it contains.

Range

Record(CollectionColumns<Type>)

String

Glob

Table(CollectionColumns<Type>)

Implementations

impl Type

pub fn list(inner: Type) -> Self

pub fn one_of(types: impl IntoIterator<Item = Type>) -> Self

Creates a OneOf type from an iterator of types. Flattens any nested OneOf types and removes duplicates.

pub fn record() -> Self

pub fn table() -> Self

pub fn custom(name: impl Into<Box<str>>) -> Self

pub fn supertype_of(it: impl IntoIterator<Item = Type>) -> Option<Self>

Returns a supertype of all types within it that is not Any. If it contains Type::Any, short circuits and returns None.

pub fn is_numeric(&self) -> bool

pub fn is_list(&self) -> bool

pub fn accepts_cell_paths(&self) -> bool

Does this type represent a data structure containing values that can be addressed using ‘cell paths’?

pub fn to_shape(&self) -> SyntaxShape

pub fn get_non_specified_string(&self) -> String

Get a string representation, without inner type specification of lists, tables and records (get list instead of list<any>

pub fn follow_cell_path<'a>( &'a self, path_members: &'a [PathMember], ) -> Option<Cow<'a, Self>>

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompareTypes for Type

fn is_subtype_of(&self, other: &Self) -> bool

Determine of the Type is a subtype of other.

This should only be used at parse-time. If you have a concrete Value or PipelineData, you should use their respective is_subtype_of methods instead.

fn compare_types(&self, other: &Self) -> Option<TypeRelation>

Compares types and returns their relation with regards to subtyping.

fn is_any(&self) -> bool

Allows having an “escape hatch”.

fn is_assignable_to(&self, dst: &Self) -> bool

Equivalent to CompareTypes::is_subtype_of by default.

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

Returns true if self is equal to or is a strict supertype of other

impl CompareTypes<OneOf> for Type

fn compare_types(&self, other: &OneOf) -> Option<TypeRelation>

Compares types and returns their relation with regards to subtyping.

fn is_subtype_of(&self, other: &OneOf) -> bool

Returns true if self is equal to or is a strict subtype of other

fn is_supertype_of(&self, other: &OneOf) -> bool

Returns true if self is equal to or is a strict supertype of other

fn is_assignable_to(&self, dst: &OneOf) -> bool

Equivalent to CompareTypes::is_subtype_of by default.

fn is_any(&self) -> bool

Allows having an “escape hatch”.

impl CompareTypes<Type> for OneOf

fn compare_types(&self, other: &Type) -> Option<TypeRelation>

Compares types and returns their relation with regards to subtyping.

fn is_subtype_of(&self, other: &Type) -> bool

Returns true if self is equal to or is a strict subtype of other

fn is_supertype_of(&self, other: &Type) -> bool

Returns true if self is equal to or is a strict supertype of other

fn is_assignable_to(&self, dst: &Type) -> bool

Equivalent to CompareTypes::is_subtype_of by default.

fn is_any(&self) -> bool

Allows having an “escape hatch”.

impl CompareTypes<Type> for PipelineData

fn is_assignable_to(&self, dst: &Type) -> bool

Determine if the PipelineData can be assigned to other.

This check makes no effort to collect a stream, so it may be a different result than would be returned by calling Value::is_subtype_of() on the result of .into_value().

A ListStream acts the same as an empty list type: it is a subtype of any list or table type. After converting to a value, it may become a more specific type. For example, a ListStream is a subtype of list<int> and list<string>. If calling .into_value() results in a list<int>, then the value would not be a subtype of list<string>, in contrast to the original ListStream.

A ByteStream is a subtype of string if it is coercible into a string. Likewise, a ByteStream is a subtype of binary if it is coercible into a binary value.

fn compare_types(&self, other: &Type) -> Option<TypeRelation>

Compares types and returns their relation with regards to subtyping.

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

Returns true if self is equal to or is a strict subtype of other

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

Returns true if self is equal to or is a strict supertype of other

fn is_any(&self) -> bool

Allows having an “escape hatch”.

impl CompareTypes<Type> for Value

fn is_subtype_of(&self, other: &Type) -> bool

Determine if the Value is a subtype of other

If you have a Value, this method should always be used over chaining Value::get_type with Type::is_subtype_of.

This method is able to leverage that information encoded in a Value to provide more accurate type comparison than if one were to collect the type into Type value with Value::get_type.

Empty lists are considered subtypes of all list<T> types.

Lists of mixed records where some column is present in all record is a subtype of table<column>. For example, [{a: 1, b: 2}, {a: 1}] is a subtype of table<a: int> (but not table<a: int, b: int>).

See also: PipelineData::is_subtype_of

fn compare_types(&self, other: &Type) -> Option<TypeRelation>

Compares types and returns their relation with regards to subtyping.

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

Returns true if self is equal to or is a strict supertype of other

fn is_any(&self) -> bool

Allows having an “escape hatch”.

fn is_assignable_to(&self, dst: &Rhs) -> bool

Equivalent to CompareTypes::is_subtype_of by default.

impl Debug for Type

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

Formats the value using the given formatter.

impl Default for Type

fn default() -> Type

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Type

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Type

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

Formats the value using the given formatter.

impl Eq for Type

impl From<ByteStreamType> for Type

fn from(value: ByteStreamType) -> Self

Converts to this type from the input type.

impl FromIterator<Type> for OneOf

fn from_iter<I: IntoIterator<Item = Type>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for Type

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 Type

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

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

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

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 Type

impl TypeSet for Type

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

Returns the narrowest common supertype of the given types.