Struct tantivy::schema::Term

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

Term represents the value that the token can take. It’s a serialized representation over different types.

It actually wraps a Vec<u8>. The first 5 bytes are metadata. 4 bytes are the field id, and the last byte is the type.

The serialized value ValueBytes is considered everything after the 4 first bytes (term id).

Implementations

impl Term

pub fn with_capacity(capacity: usize) -> Term

Create a new Term with a buffer with a given capacity.

pub fn is_empty(&self) -> bool

Is empty if there are no value bytes.

pub fn from_field_ip_addr(field: Field, ip_addr: Ipv6Addr) -> Term

Builds a term given a field, and a Ipv6Addr-value

pub fn from_field_u64(field: Field, val: u64) -> Term

Builds a term given a field, and a u64-value

pub fn from_field_i64(field: Field, val: i64) -> Term

Builds a term given a field, and a i64-value

pub fn from_field_f64(field: Field, val: f64) -> Term

Builds a term given a field, and a f64-value

pub fn from_field_bool(field: Field, val: bool) -> Term

Builds a term given a field, and a bool-value

pub fn from_field_date(field: Field, val: DateTime) -> Term

Builds a term given a field, and a DateTime value

pub fn from_facet(field: Field, facet: &Facet) -> Term

Creates a Term given a facet.

pub fn from_field_text(field: Field, text: &str) -> Term

Builds a term given a field, and a string value

pub fn from_field_bytes(field: Field, bytes: &[u8]) -> Term

Builds a term bytes.

pub fn clear_with_type(&mut self, typ: Type)

Removes the value_bytes and set the type code.

pub fn set_u64(&mut self, val: u64)

Sets a u64 value in the term.

U64 are serialized using (8-byte) BigEndian representation. The use of BigEndian has the benefit of preserving the natural order of the values.

pub fn set_i64(&mut self, val: i64)

Sets a i64 value in the term.

pub fn set_date(&mut self, date: DateTime)

Sets a DateTime value in the term.

pub fn set_f64(&mut self, val: f64)

Sets a f64 value in the term.

pub fn set_bool(&mut self, val: bool)

Sets a bool value in the term.

pub fn set_ip_addr(&mut self, val: Ipv6Addr)

Sets a Ipv6Addr value in the term.

pub fn set_bytes(&mut self, bytes: &[u8])

Sets the value of a Bytes field.

pub fn set_text(&mut self, text: &str)

Set the texts only, keeping the field untouched.

pub fn truncate_value_bytes(&mut self, len: usize)

Truncates the value bytes of the term. Value and field type stays the same.

pub fn len_bytes(&self) -> usize

The length of the bytes.

pub fn append_bytes(&mut self, bytes: &[u8]) -> &mut [u8]

Appends value bytes to the Term.

This function returns the segment that has just been added.

pub fn append_path(&mut self, bytes: &[u8]) -> &mut [u8]

Appends json path bytes to the Term. If the path contains 0 bytes, they are replaced by a “0” string. The 0 byte is used to mark the end of the path.

This function returns the segment that has just been added.

pub fn add_json_path_separator(&mut self)

Appends a JSON_PATH_SEGMENT_SEP to the term. Only used for JSON type.

pub fn set_json_path_end(&mut self)

Sets the current end to JSON_END_OF_PATH. Only used for JSON type.

pub fn set_json_path_separator(&mut self)

Sets the current end to JSON_PATH_SEGMENT_SEP. Only used for JSON type.

impl<B> Term<B>

where B: AsRef<[u8]>,

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

Wraps a object holding bytes

pub fn typ(&self) -> Type

Return the type of the term.

pub fn field(&self) -> Field

Returns the field.

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

Returns the serialized representation of the value. (this does neither include the field id nor the value type.)

If the term is a string, its value is utf-8 encoded. If the term is a u64, its value is encoded according to byteorder::BigEndian.

pub fn value(&self) -> ValueBytes<&[u8]>

Returns the value of the term. address or JSON path + value. (this does not include the field.)

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

Returns the serialized representation of Term. This includes field_id, value type and value.

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 Term<B>

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for Term<B>

where B: AsRef<[u8]>,

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

Formats the value using the given formatter.

impl<B> Hash for Term<B>

where B: AsRef<[u8]>,

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<B> Ord for Term<B>

where B: AsRef<[u8]>,

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

Restrict a value to a certain interval.

impl<B> PartialEq for Term<B>

where B: AsRef<[u8]>,

fn eq(&self, other: &Self) -> 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<B> PartialOrd for Term<B>

where B: AsRef<[u8]>,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<B> Eq for Term<B>

where B: AsRef<[u8]>,