Struct tantivy::Term

pub struct Term<B = Vec<u8>>(_)
 where
    B: AsRef<[u8]>;

Term represents the value that the token can take.

It actually wraps a Vec<u8>.

Methods

impl Term

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

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

Assuming the term has a field id of 1, and a u64 value of 3234, the Term will have 8 bytes.

The first four byte are dedicated to storing the field id as a u64. The 4 following bytes are encoding the u64 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

Assuming the term has a field id of 2, and a text value of "abc", the Term will have 4 bytes. The first byte is 2, and the three following bytes are the utf-8 representation of "abc".

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

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

Assuming the term has a field id of 1, and a u64 value of 3234, the Term will have 8 bytes.

The first four byte are dedicated to storing the field id as a u64. The 4 following bytes are encoding the u64 value.

pub fn set_field(&mut self, field: Field)

Returns the field.

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_text(&mut self, text: &str)

Set the texts only, keeping the field untouched.

impl<B> Term<B> where     B: AsRef<[u8]>,

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

Wraps a source of data

pub fn field(&self) -> Field

Returns the field.

pub fn get_u64(&self) -> u64

Returns the u64 value stored in a term.

Panics

... or returns an invalid value if the term is not a u64 field.

pub fn get_i64(&self) -> i64

Returns the i64 value stored in a term.

Panics

... or returns an invalid value if the term is not a i64 field.

pub fn text(&self) -> &str

Returns the text associated with the term.

Panics

If the value is not valid utf-8. This may happen if the index is corrupted or if you try to call this method on a non-string type.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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

Returns the serialized value of the term. (this does not include the field.)

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::LittleEndian.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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

Returns the underlying &[u8]

Trait Implementations

impl<B: Clone> Clone for Term<B> where     B: AsRef<[u8]>,

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: PartialEq> PartialEq for Term<B> where     B: AsRef<[u8]>,

fn eq(&self, other: &Term<B>) -> bool

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

fn ne(&self, other: &Term<B>) -> bool

This method tests for !=.

impl<B: PartialOrd> PartialOrd for Term<B> where     B: AsRef<[u8]>,

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

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

fn lt(&self, other: &Term<B>) -> bool

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

fn le(&self, other: &Term<B>) -> bool

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

fn gt(&self, other: &Term<B>) -> bool

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

fn ge(&self, other: &Term<B>) -> bool

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

impl<B: Ord> Ord for Term<B> where     B: AsRef<[u8]>,

fn cmp(&self, other: &Term<B>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<B: Eq> Eq for Term<B> where     B: AsRef<[u8]>,

impl<B: Hash> Hash for Term<B> where     B: AsRef<[u8]>,

fn hash<__HB: Hasher>(&self, state: &mut __HB)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl<B> AsRef<[u8]> for Term<B> where     B: AsRef<[u8]>,

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Debug for Term

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

Formats the value using the given formatter.