Struct TypeDef 

pub struct TypeDef { /* private fields */ }

Properties for a given expression that express the expected outcome of the expression.

Implementations

impl TypeDef

pub fn kind(&self) -> &Kind

pub fn kind_mut(&mut self) -> &mut Kind

pub fn returns(&self) -> &Kind

pub fn returns_mut(&mut self) -> &mut Kind

pub fn at_path<'a>(&self, path: impl ValuePath<'a>) -> TypeDef

pub fn fallible(self) -> Self

pub fn infallible(self) -> Self

pub fn always_fails(self) -> Self

pub fn maybe_fallible(self, might_fail: bool) -> Self

Provided for backwards compatibility. Prefer with_fallibility for new code.

pub fn with_fallibility(self, fallibility: Fallibility) -> Self

pub fn pure(self) -> Self

pub fn impure(self) -> Self

pub fn any() -> Self

pub fn bytes() -> Self

pub fn or_bytes(self) -> Self

pub fn integer() -> Self

pub fn or_integer(self) -> Self

pub fn float() -> Self

pub fn or_float(self) -> Self

pub fn boolean() -> Self

pub fn or_boolean(self) -> Self

pub fn timestamp() -> Self

pub fn or_timestamp(self) -> Self

pub fn regex() -> Self

pub fn or_regex(self) -> Self

pub fn null() -> Self

pub fn or_null(self) -> Self

pub fn undefined() -> Self

pub fn or_undefined(self) -> Self

pub fn never() -> Self

pub fn add_null(self) -> Self

pub fn array(collection: impl Into<Collection<Index>>) -> Self

pub fn or_array(self, collection: impl Into<Collection<Index>>) -> Self

pub fn restrict_array(self) -> Self

Convert the TypeDefs Kind to an array.

If Kind already has the array state, all other states are removed. If it does not yet have an array, then equally all existing states are removed, and an “any” array state is added.

TypeDefs fallibility is kept unmodified.

pub fn object(collection: impl Into<Collection<Field>>) -> Self

pub fn or_object(self, collection: impl Into<Collection<Field>>) -> Self

pub fn restrict_object(self) -> Self

Convert the TypeDefs Kind to an object.

If Kind already has the object state, all other states are removed. If it does not yet have an object, then equally all existing states are removed, and an “any” object state is added.

TypeDefs fallibility is kept unmodified.

pub fn with_kind(self, kind: Kind) -> Self

pub fn with_returns(self, returns: Kind) -> Self

pub fn upgrade_undefined(self) -> Self

VRL has an interesting property where accessing an undefined value “upgrades” it to a “null” value. This should be used in places those implicit upgrades can occur.

pub fn collect_subtypes(self) -> Self

Collects any subtypes that can contain multiple indexed types (array, object) and collects them into a single type for all indexes.

Used for functions that cant determine which indexes of a collection have been used in the result.

pub fn is_fallible(&self) -> bool

pub fn is_infallible(&self) -> bool

pub fn is_pure(&self) -> bool

pub fn is_impure(&self) -> bool

pub fn fallible_unless(self, kind: impl Into<Kind>) -> Self

Set the type definition to be fallible if its kind is not contained within the provided kind.

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

pub fn merge(&mut self, other: Self, strategy: Strategy)

pub fn with_type_inserted<'a>( self, path: impl ValuePath<'a>, other: Self, ) -> Self

pub fn merge_overwrite(self, other: Self) -> Self

Methods from Deref<Target = Kind>

pub fn add_bytes(&mut self) -> bool

Add the bytes state to the type.

If the type already included this state, the function returns false.

pub fn add_integer(&mut self) -> bool

Add the integer state to the type.

If the type already included this state, the function returns false.

pub fn add_float(&mut self) -> bool

Add the float state to the type.

If the type already included this state, the function returns false.

pub fn add_boolean(&mut self) -> bool

Add the boolean state to the type.

If the type already included this state, the function returns false.

pub fn add_timestamp(&mut self) -> bool

Add the timestamp state to the type.

If the type already included this state, the function returns false.

pub fn add_regex(&mut self) -> bool

Add the regex state to the type.

If the type already included this state, the function returns false.

pub fn add_null(&mut self) -> bool

Add the null state to the type.

If the type already included this state, the function returns false.

pub fn add_undefined(&mut self) -> bool

Add the null state to the type.

If the type already included this state, the function returns false.

pub fn add_array(&mut self, collection: impl Into<Collection<Index>>) -> bool

Add the array state to the type.

If the type already included this state, the function returns false.

pub fn add_object(&mut self, collection: impl Into<Collection<Field>>) -> bool

Add the object state to the type.

If the type already included this state, the function returns false.

pub fn remove_bytes(&mut self) -> bool

Remove the bytes state from the type.

If the type previously included this state, true is returned.

pub fn remove_integer(&mut self) -> bool

Remove the integer state from the type.

If the type previously included this state, true is returned.

pub fn remove_float(&mut self) -> bool

Remove the float state from the type.

If the type previously included this state, true is returned.

pub fn remove_boolean(&mut self) -> bool

Remove the boolean state from the type.

If the type previously included this state, true is returned.

pub fn remove_timestamp(&mut self) -> bool

Remove the timestamp state from the type.

If the type previously included this state, true is returned.

pub fn remove_regex(&mut self) -> bool

Remove the regex state from the type.

If the type previously included this state, true is returned.

pub fn remove_null(&mut self) -> bool

Remove the null state from the type.

If the type previously included this state, true is returned.

pub fn remove_undefined(&mut self) -> bool

Remove the undefined state from the type.

If the type previously included this state, true is returned.

pub fn remove_array(&mut self) -> bool

Remove the array state from the type.

If the type previously included this state, true is returned.

pub fn remove_object(&mut self) -> bool

Remove the object state from the type.

If the type previously included this state, true is returned.

pub fn without_undefined(&self) -> Self

Remove the undefined state from the type, and return it.

pub fn without_array(&self) -> Self

Remove the array state from the type, and return it.

pub fn without_object(&self) -> Self

Remove the object state from the type, and return it.

pub fn is_any(&self) -> bool

Returns true if all type states are valid.

That is, this method only returns true if the object matches all of the known types.

pub fn is_json(&self) -> bool

Returns true if the JSON type states are valid.

pub fn is_collection(&self) -> bool

Returns true if only collection type states are valid.

pub fn is_bytes(&self) -> bool

Returns true if the type is bytes.

pub fn is_integer(&self) -> bool

Returns true if the type is integer.

pub fn is_never(&self) -> bool

Returns true if the type is never.

pub fn is_float(&self) -> bool

Returns true if the type is float.

pub fn is_boolean(&self) -> bool

Returns true if the type is boolean.

pub fn is_timestamp(&self) -> bool

Returns true if the type is timestamp.

pub fn is_regex(&self) -> bool

Returns true if the type is regex.

pub fn is_null(&self) -> bool

Returns true if the type is null.

pub fn is_undefined(&self) -> bool

Returns true if the type is undefined.

pub fn is_array(&self) -> bool

Returns true if the type is array.

pub fn is_object(&self) -> bool

Returns true if the type is object.

pub fn is_exact(&self) -> bool

Returns true if at most one type is set.

pub fn is_superset(&self, other: &Self) -> Result<(), OwnedValuePath>

Check if self is a superset of other.

Meaning, if other has a type defined as valid, then self needs to have it defined as valid as well.

Collection types are recursively checked (meaning, known fields in self also need to be a superset of other.

Errors

If the type is not a superset, a path to one field that doesn’t match is returned. This is mostly useful for debugging.

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

Check if self intersects other.

Returns true if there are type states common to both self and other.

pub fn contains_bytes(&self) -> bool

Returns true if the type is at least bytes.

pub fn contains_integer(&self) -> bool

Returns true if the type is at least integer.

pub fn contains_float(&self) -> bool

Returns true if the type is at least float.

pub fn contains_boolean(&self) -> bool

Returns true if the type is at least boolean.

pub fn contains_timestamp(&self) -> bool

Returns true if the type is at least timestamp.

pub fn contains_regex(&self) -> bool

Returns true if the type is at least regex.

pub fn contains_null(&self) -> bool

Returns true if the type is at least null.

pub fn contains_undefined(&self) -> bool

Returns true if the type is at least undefined.

pub fn contains_any_defined(&self) -> bool

Returns true if the type can be any type other than undefined

pub fn contains_array(&self) -> bool

Returns true if the type is at least array.

pub fn contains_object(&self) -> bool

Returns true if the type is at least object.

pub fn contains_primitive(&self) -> bool

Returns true if the type contains at least one non-collection type.

pub fn as_object(&self) -> Option<&Collection<Field>>

Get the inner object collection.

This returns None if the type is not known to be an object.

pub fn as_object_mut(&mut self) -> Option<&mut Collection<Field>>

Get a mutable reference to the inner object collection.

This returns None if the type is not known to be an object.

pub fn as_array(&self) -> Option<&Collection<Index>>

Get the inner array collection.

This returns None if the type is not known to be an array.

pub fn as_array_mut(&mut self) -> Option<&mut Collection<Index>>

Get a mutable reference to the inner array collection.

This returns None if the type is not known to be an array.

pub fn get<'a>(&self, path: impl ValuePath<'a>) -> Self

Returns the type of a value that is retrieved from a certain path.

This has the same behavior as Value::get, including the implicit conversion of “undefined” to “null.

If you want the type without the implicit type conversion, use Kind::at_path instead.

pub fn at_path<'a>(&self, path: impl ValuePath<'a>) -> Self

This retrieves the Kind at a given path. There is a subtle difference between this and Kind::get where this function does not convert undefined to null. It is viewing the type of a value in-place, before it is retrieved.

pub fn insert<'a>(&mut self, path: impl ValuePath<'a>, kind: Self)

Insert the Kind at the given path within self. This has the same behavior as Value::insert.

pub fn set_at_path<'a>(&mut self, path: impl ValuePath<'a>, kind: Self)

Set the Kind at the given path within self. There is a subtle difference between this and Kind::insert where this function does not convert undefined to null.

pub fn insert_recursive<'a, 'b>( &'a mut self, iter: impl Iterator<Item = BorrowedSegment<'b>> + Clone, kind: Self, )

Insert the Kind at the given path within self. This has the same behavior as Value::insert.

Panics

Object/Array not present in self.

pub fn remove(&mut self, path: &OwnedValuePath, prune: bool) -> Self

Removes the Kind at the given path within self. This has the same behavior as Value::remove.

pub fn debug_info(&self) -> ObjectMap

Returns a tree representation of Kind, in a more human readable format. This is for debugging / development purposes only.

pub fn merge(&mut self, other: Self, strategy: Strategy)

Merge other into self, using the provided Strategy.

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

Returns the union of self and other.

pub fn merge_keep(&mut self, other: Self, overwrite: bool)

Merge other into self, optionally overwriting on conflicts.

pub fn canonicalize(&self) -> Self

Returns a Kind type in a standard / simple representation.

Trait Implementations

impl Clone for TypeDef

fn clone(&self) -> TypeDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeDef

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

Formats the value using the given formatter.

impl Deref for TypeDef

type Target = Kind

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for TypeDef

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Kind> for TypeDef

fn from(kind: Kind) -> Self

Converts to this type from the input type.

impl From<TypeDef> for Kind

fn from(type_def: TypeDef) -> Self

Converts to this type from the input type.

impl PartialEq for TypeDef

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

impl StructuralPartialEq for TypeDef