Enum tantivy::schema::document::OwnedValue

pub enum OwnedValue {
    Null,
    Str(String),
    PreTokStr(PreTokenizedString),
    U64(u64),
    I64(i64),
    F64(f64),
    Bool(bool),
    Date(DateTime),
    Facet(Facet),
    Bytes(Vec<u8>),
    Array(Vec<Self>),
    Object(BTreeMap<String, Self>),
    IpAddr(Ipv6Addr),
}

This is a owned variant of Value, that can be passed around without lifetimes. Represents the value of a any field. It is an enum over all over all of the possible field type.

Variants

Null

A null value.

Str(String)

The str type is used for any text information.

PreTokStr(PreTokenizedString)

Pre-tokenized str type,

U64(u64)

Unsigned 64-bits Integer u64

I64(i64)

Signed 64-bits Integer i64

F64(f64)

64-bits Float f64

Bool(bool)

Bool value

Date(DateTime)

Date/time with nanoseconds precision

Facet(Facet)

Facet

Bytes(Vec<u8>)

Arbitrarily sized byte array

Array(Vec<Self>)

A set of values.

Object(BTreeMap<String, Self>)

Dynamic object value.

IpAddr(Ipv6Addr)

IpV6 Address. Internally there is no IpV4, it needs to be converted to Ipv6Addr.

Trait Implementations

impl AsRef<OwnedValue> for OwnedValue

fn as_ref(&self) -> &OwnedValue

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for OwnedValue

fn clone(&self) -> OwnedValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OwnedValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a [u8]> for OwnedValue

fn from(bytes: &'a [u8]) -> OwnedValue

Converts to this type from the input type.

impl<'a> From<&'a str> for OwnedValue

fn from(s: &'a str) -> OwnedValue

Converts to this type from the input type.

impl From<BTreeMap<String, OwnedValue>> for OwnedValue

fn from(object: BTreeMap<String, OwnedValue>) -> OwnedValue

Converts to this type from the input type.

impl From<DateTime> for OwnedValue

fn from(dt: DateTime) -> OwnedValue

Converts to this type from the input type.

impl From<Facet> for OwnedValue

fn from(facet: Facet) -> OwnedValue

Converts to this type from the input type.

impl From<FastFieldValue> for OwnedValue

fn from(value: FastFieldValue) -> Self

Converts to this type from the input type.

impl From<FieldValue> for OwnedValue

fn from(field_value: FieldValue) -> Self

Converts to this type from the input type.

impl From<Ipv6Addr> for OwnedValue

fn from(v: Ipv6Addr) -> OwnedValue

Converts to this type from the input type.

impl From<Map<String, Value>> for OwnedValue

fn from(map: Map<String, Value>) -> Self

Converts to this type from the input type.

impl From<PreTokenizedString> for OwnedValue

fn from(pretokenized_string: PreTokenizedString) -> OwnedValue

Converts to this type from the input type.

impl<'a, V: Value<'a>> From<ReferenceValue<'a, V>> for OwnedValue

fn from(val: ReferenceValue<'a, V>) -> OwnedValue

Converts to this type from the input type.

impl From<String> for OwnedValue

fn from(s: String) -> OwnedValue

Converts to this type from the input type.

impl From<Value> for OwnedValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for OwnedValue

fn from(bytes: Vec<u8>) -> OwnedValue

Converts to this type from the input type.

impl From<bool> for OwnedValue

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for OwnedValue

fn from(v: f64) -> OwnedValue

Converts to this type from the input type.

impl From<i64> for OwnedValue

fn from(v: i64) -> OwnedValue

Converts to this type from the input type.

impl From<u64> for OwnedValue

fn from(v: u64) -> OwnedValue

Converts to this type from the input type.

impl PartialEq for OwnedValue

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for OwnedValue

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Value<'a> for &'a OwnedValue

type ArrayIter = Iter<'a, OwnedValue>

The child value type returned by this doc value. The iterator for walking through the elements within the array.

type ObjectIter = ObjectMapIter<'a>

The visitor walking through the key-value pairs within the object.

fn as_value(&self) -> ReferenceValue<'a, Self>

Returns the field value represented by an enum which borrows it’s data.

fn is_null(&self) -> bool

Returns if the value is null or not.

fn as_leaf(&self) -> Option<ReferenceValueLeaf<'a>>

If the Value is a String, returns the associated str. Returns None otherwise.

fn as_str(&self) -> Option<&'a str>

If the Value is a String, returns the associated str. Returns None otherwise.

fn as_u64(&self) -> Option<u64>

If the Value is a u64, returns the associated u64. Returns None otherwise.

fn as_i64(&self) -> Option<i64>

If the Value is a i64, returns the associated i64. Returns None otherwise.

fn as_f64(&self) -> Option<f64>

If the Value is a f64, returns the associated f64. Returns None otherwise.

fn as_datetime(&self) -> Option<DateTime>

If the Value is a datetime, returns the associated datetime. Returns None otherwise.

fn as_ip_addr(&self) -> Option<Ipv6Addr>

If the Value is a IP address, returns the associated IP. Returns None otherwise.

fn as_bool(&self) -> Option<bool>

If the Value is a bool, returns the associated bool. Returns None otherwise.

fn as_pre_tokenized_text(&self) -> Option<&'a PreTokenizedString>

If the Value is a pre-tokenized string, returns the associated string. Returns None otherwise.

fn as_bytes(&self) -> Option<&'a [u8]>

If the Value is a bytes value, returns the associated set of bytes. Returns None otherwise.

fn as_facet(&self) -> Option<&'a Facet>

If the Value is a facet, returns the associated facet. Returns None otherwise.

fn as_array(&self) -> Option<Self::ArrayIter>

Returns the iterator over the array if the Value is an array.

fn as_object(&self) -> Option<Self::ObjectIter>

Returns the iterator over the object if the Value is an object.

fn is_array(&self) -> bool

Returns true if the Value is an array.

fn is_object(&self) -> bool

Returns true if the Value is an object.

impl ValueDeserialize for OwnedValue

fn deserialize<'de, D>(deserializer: D) -> Result<Self, DeserializeError>

where D: ValueDeserializer<'de>,

Attempts to deserialize Self from a given value deserializer.

impl Eq for OwnedValue

impl StructuralPartialEq for OwnedValue