Enum vector::sinks::prelude::Value

pub enum Value {
    Bytes(Bytes),
    Regex(ValueRegex),
    Integer(i64),
    Float(NotNan<f64>),
    Boolean(bool),
    Timestamp(DateTime<Utc>),
    Object(BTreeMap<KeyString, Value>),
    Array(Vec<Value>),
    Null,
}

Expand description

The main value type used in Vector events, and VRL.

Variants§

§

Bytes(Bytes)

Bytes - usually representing a UTF8 String.

§

Regex(ValueRegex)

Regex. When used in the context of Vector this is treated identically to Bytes. It has additional meaning in the context of VRL.

§

Integer(i64)

Integer.

§

Float(NotNan<f64>)

Float - not NaN.

§

Boolean(bool)

Boolean.

§

Timestamp(DateTime<Utc>)

Timestamp (UTC).

§

Object(BTreeMap<KeyString, Value>)

Object.

§

Array(Vec<Value>)

Array.

§

Null

Null.

Implementations§

§

impl Value

pub fn as_float(&self) -> Option<NotNan<f64>>

Returns self as NotNan<f64>, only if self is Value::Float.

pub fn into_object(self) -> Option<BTreeMap<KeyString, Value>>

Returns self as ObjectMap, only if self is Value::Object.

pub fn as_timestamp(&self) -> Option<&DateTime<Utc>>

Returns self as &DateTime<Utc>, only if self is Value::Timestamp.

pub fn as_timestamp_unwrap(&self) -> &DateTime<Utc>

Returns self as a DateTime<Utc>.

§Panics

This function will panic if self is anything other than Value::Timestamp.

pub fn as_object_mut_unwrap(&mut self) -> &mut BTreeMap<KeyString, Value>

Returns self as a mutable ObjectMap.

§Panics

This function will panic if self is anything other than Value::Object.

pub fn as_array_unwrap(&self) -> &[Value]

Returns self as a Vec<Value>.

§Panics

This function will panic if self is anything other than Value::Array.

pub fn as_array_mut_unwrap(&mut self) -> &mut Vec<Value>

Returns self as a mutable Vec<Value>.

§Panics

This function will panic if self is anything other than Value::Array.

pub fn is_integer(&self) -> bool

Returns true if self is Value::Integer.

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

Returns self as f64, only if self is Value::Integer.

pub fn is_float(&self) -> bool

Returns true if self is Value::Float.

pub fn from_f64_or_zero(value: f64) -> Value

Creates a Value from an f64. If the value is Nan, it is converted to 0.0

§Panics

If NaN is used as a default value.

pub fn is_bytes(&self) -> bool

Returns true if self is Value::Bytes.

pub fn as_bytes(&self) -> Option<&Bytes>

Returns self as &Bytes, only if self is Value::Bytes.

pub fn as_str(&self) -> Option<Cow<'_, str>>

Returns self as Cow<str>, only if self is Value::Bytes

pub fn encode_as_bytes(&self) -> Result<Bytes, String>

Converts the Value into a byte representation regardless of its original type. Object and Array are currently not supported, although technically there’s no reason why it couldn’t in future should the need arise.

§Errors

If the type is Object or Array, and string error description will be returned

pub fn is_boolean(&self) -> bool

Returns true if self is Value::Boolean.

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

Returns self as bool, only if self is Value::Boolean.

pub fn is_regex(&self) -> bool

Returns true if self is Value::Regex.

pub fn as_regex(&self) -> Option<&Regex>

Returns self as &ValueRegex, only if self is Value::Regex.

pub fn is_null(&self) -> bool

Returns true if self is Value::Null.

pub fn as_null(&self) -> Option<()>

Returns self as ()), only if self is Value::Null.

pub fn is_array(&self) -> bool

Returns true if self is Value::Array.

pub fn as_array(&self) -> Option<&[Value]>

Returns self as &[Value], only if self is Value::Array.

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>

Returns self as &mut Vec<Value>, only if self is Value::Array.

pub fn is_object(&self) -> bool

Returns true if self is Value::Object.

pub fn as_object(&self) -> Option<&BTreeMap<KeyString, Value>>

Returns self as &ObjectMap, only if self is Value::Object.

pub fn as_object_mut(&mut self) -> Option<&mut BTreeMap<KeyString, Value>>

Returns self as &mut ObjectMap, only if self is Value::Object.

pub fn is_timestamp(&self) -> bool

Returns true if self is Value::Timestamp.

pub fn kind(&self) -> Kind

Returns the Kind of this Value

§

impl Value

pub fn into_iter<'a>(self, recursive: bool) -> ValueIter<'a>

Create an iterator over the Value.

For non-collection types, this returns a single-item iterator similar to Option’s iterator implementation.

For collection types, it returns all elements in the collection.

The resulting item is an [IterItem], which contains either a mutable Value for non-collection types, a (&mut KeyString, &mut Value) pair for object-type collections, or an immutable/mutable (usize, &mut Value) pair for array-type collections.

§Recursion

If recursion is set to true, the iterator recurses into nested collection types.

Recursion follows these rules:

When a collection type is found, that type is first returned as-is. That is, if we’re iterating over an object, and within that object is a field “foo” containing an array, then we first return IterItem::KeyValue, which contains the key “foo”, and the array as the value.
After returning the collection type, the iterator recurses into the nested collection itself. Using the previous example, we now go into the array, and start returning IterItem::IndexValue variants for the elements within the array.
Any mutations done to the array before recursing into it are preserved, meaning once recursion starts, the mutations done on the object itself are preserved.

§

impl Value

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

Insert the current value into a given path.

For example, given the path .foo.bar and value true, the return value would be an object representing { "foo": { "bar": true } }.

§

impl Value

pub fn coerce_to_bytes(&self) -> Bytes

Converts self into a Bytes, using JSON for Map/Array.

§Panics

If map or array serialization fails.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts self into a String representation, using JSON for Map/Array.

§Panics

If map or array serialization fails.

§

impl Value

pub const fn kind_str(&self) -> &str

Returns a string description of the value type

pub fn merge(&mut self, incoming: Value)

Merges incoming value into self.

Will concatenate Bytes and overwrite the rest value kinds.

pub fn is_empty(&self) -> bool

Return if the node is empty, that is, it is an array or map with no items.

use vrl::value::Value;
use std::collections::BTreeMap;
use vrl::path;

let val = Value::from(1);
assert_eq!(val.is_empty(), false);

let mut val = Value::from(Vec::<Value>::default());
assert_eq!(val.is_empty(), true);
val.insert(path!(0), 1);
assert_eq!(val.is_empty(), false);
val.insert(path!(3), 1);
assert_eq!(val.is_empty(), false);

let mut val = Value::from(BTreeMap::default());
assert_eq!(val.is_empty(), true);
val.insert(path!("foo"), 1);
assert_eq!(val.is_empty(), false);
val.insert(path!("bar"), 2);
assert_eq!(val.is_empty(), false);

pub fn insert<'a>( &mut self, path: impl ValuePath<'a>, insert_value: impl Into<Value>, ) -> Option<Value>

Returns a reference to a field value specified by a path iter.

pub fn remove<'a>( &mut self, path: impl ValuePath<'a>, prune: bool, ) -> Option<Value>

Removes field value specified by the given path and return its value.

A special case worth mentioning: if there is a nested array and an item is removed from the middle of this array, then it is just replaced by Value::Null.

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

Returns a reference to a field value specified by a path iter.

pub fn get_mut<'a>(&mut self, path: impl ValuePath<'a>) -> Option<&mut Value>

Get a mutable borrow of the value by path

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

Determine if the lookup is contained within the value.

Trait Implementations§

§

impl Arbitrary for Value

§

fn arbitrary(g: &mut Gen) -> Value

Return an arbitrary value. Read more

§

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself. Read more

Enum vector::sinks::prelude::ValueCopy item path

Variants§

Bytes(Bytes)

Regex(ValueRegex)

Integer(i64)

Float(NotNan<f64>)

Boolean(bool)

Timestamp(DateTime<Utc>)

Object(BTreeMap<KeyString, Value>)

Array(Vec<Value>)

Null

Implementations§

impl Value

pub fn as_float(&self) -> Option<NotNan<f64>>

pub fn into_object(self) -> Option<BTreeMap<KeyString, Value>>

pub fn as_timestamp(&self) -> Option<&DateTime<Utc>>

pub fn as_timestamp_unwrap(&self) -> &DateTime<Utc>

§Panics

pub fn as_object_mut_unwrap(&mut self) -> &mut BTreeMap<KeyString, Value>

§Panics

pub fn as_array_unwrap(&self) -> &[Value]

§Panics

pub fn as_array_mut_unwrap(&mut self) -> &mut Vec<Value>

§Panics

pub fn is_integer(&self) -> bool

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

pub fn is_float(&self) -> bool

pub fn from_f64_or_zero(value: f64) -> Value

§Panics

pub fn is_bytes(&self) -> bool

pub fn as_bytes(&self) -> Option<&Bytes>

pub fn as_str(&self) -> Option<Cow<'_, str>>

pub fn encode_as_bytes(&self) -> Result<Bytes, String>

§Errors

pub fn is_boolean(&self) -> bool

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

pub fn is_regex(&self) -> bool

pub fn as_regex(&self) -> Option<&Regex>

pub fn is_null(&self) -> bool

pub fn as_null(&self) -> Option<()>

pub fn is_array(&self) -> bool

pub fn as_array(&self) -> Option<&[Value]>

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>

pub fn is_object(&self) -> bool

pub fn as_object(&self) -> Option<&BTreeMap<KeyString, Value>>

pub fn as_object_mut(&mut self) -> Option<&mut BTreeMap<KeyString, Value>>

pub fn is_timestamp(&self) -> bool

pub fn kind(&self) -> Kind

impl Value

pub fn into_iter<'a>(self, recursive: bool) -> ValueIter<'a>

§Recursion

impl Value

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

impl Value

pub fn coerce_to_bytes(&self) -> Bytes

§Panics

pub fn to_string_lossy(&self) -> Cow<'_, str>

§Panics

impl Value

pub const fn kind_str(&self) -> &str

pub fn merge(&mut self, incoming: Value)

pub fn is_empty(&self) -> bool

pub fn insert<'a>( &mut self, path: impl ValuePath<'a>, insert_value: impl Into<Value>, ) -> Option<Value>

pub fn remove<'a>( &mut self, path: impl ValuePath<'a>, prune: bool, ) -> Option<Value>

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

pub fn get_mut<'a>(&mut self, path: impl ValuePath<'a>) -> Option<&mut Value>

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

Trait Implementations§

impl Arbitrary for Value

fn arbitrary(g: &mut Gen) -> Value

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

impl ByteSizeOf for Value

fn allocated_bytes(&self) -> usize

fn size_of(&self) -> usize

impl Clone for Value

fn clone(&self) -> Value

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

impl Debug for Value

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

impl<'de> Deserialize<'de> for Value

Enum vector::sinks::prelude::Value

fn deserialize<D>( deserializer: D, ) -> Result<Value, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

impl<T> From<Option<T>> for Value
where T: Into<Value>,