Struct tantivy::schema::ValueBytes

pub struct ValueBytes<B>(/* private fields */)
where
    B: AsRef<[u8]>;

ValueBytes represents a serialized value. The value can be of any type of Type (e.g. string, u64, f64, bool, date, JSON). The serialized representation matches the lexographical order of the type.

The ValueBytes format is as follow: [type code: u8][serialized value]

For JSON ValueBytes equals to: [type code=JSON][JSON path][JSON_END_OF_PATH][ValueBytes]

The nested ValueBytes in JSON is never of type JSON. (there’s no recursion)

Implementations

impl<B> ValueBytes<B>

where B: AsRef<[u8]>,

pub fn wrap(data: B) -> ValueBytes<B>

Wraps a object holding bytes

pub fn typ(&self) -> Type

Return the type of the term.

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

Returns the u64 value stored in a term.

Returns None if the term is not of the u64 type, or if the term byte representation is invalid.

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

Returns the i64 value stored in a term.

Returns None if the term is not of the i64 type, or if the term byte representation is invalid.

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

Returns the f64 value stored in a term.

Returns None if the term is not of the f64 type, or if the term byte representation is invalid.

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

Returns the bool value stored in a term.

Returns None if the term is not of the bool type, or if the term byte representation is invalid.

pub fn as_date(&self) -> Option<DateTime>

Returns the Date value stored in a term.

Returns None if the term is not of the Date type, or if the term byte representation is invalid.

pub fn as_str(&self) -> Option<&str>

Returns the text associated with the term.

Returns None if the field is not of string type or if the bytes are not valid utf-8.

pub fn as_facet(&self) -> Option<Facet>

Returns the facet associated with the term.

Returns None if the field is not of facet type or if the bytes are not valid utf-8.

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

Returns the bytes associated with the term.

Returns None if the field is not of bytes type.

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

Returns a Ipv6Addr value from the term.

pub fn json_path_type(&self) -> Option<Type>

Returns the json path type.

Returns None if the value is not JSON.

pub fn as_serialized(&self) -> &[u8]

Returns the serialized representation of Term.

Do NOT rely on this byte representation in the index. This value is likely to change in the future.

Trait Implementations

impl<B> Clone for ValueBytes<B>

where B: AsRef<[u8]> + Clone,

fn clone(&self) -> ValueBytes<B>

Returns a copy of the value.

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

Performs copy-assignment from source.