Struct tantivy::Term

source · [−]

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

Expand description

Term represents the value that the token can take.

It actually wraps a Vec<u8>.

Implementations

source

impl Term

source

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

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

source

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

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

source

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

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

source

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

Builds a term given a field, and a DateTime value

source

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

Creates a Term given a facet.

source

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

Builds a term given a field, and a string value

source

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

Builds a term bytes.

source

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.

source

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

Sets a i64 value in the term.

source

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

Sets a i64 value in the term.

source

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

Sets a f64 value in the term.

source

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

Sets the value of a Bytes field.

source

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

Set the texts only, keeping the field untouched.

source

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

Removes the value_bytes and set the type code.

source

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

Truncate the term right after the field and the type code.

source

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

Truncate the term right after the field and the type code.

source

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

source

pub fn wrap(data: B) -> Term

Wraps a object holding bytes

source

pub fn typ(&self) -> Type

Return the type of the term.

source

pub fn field(&self) -> Field

Returns the field.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

Returns the bytes associated with the term.

Returns None if the field is not of bytes type.

source

pub fn value_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [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.

Trait Implementations

source

impl AsMut<Vec<u8, Global>> for Term

source

fn as_mut(&mut self) -> &mut Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

source

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

source

fn clone(&self) -> Term

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

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

source

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

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

source

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

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

1.0.0 · source

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

This method tests for !=.

source

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

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

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

Auto Trait Implementations

impl RefUnwindSafe for Term where
B: RefUnwindSafe,

impl Send for Term where
B: Send,

impl Sync for Term where
B: Sync,

impl Unpin for Term where
B: Unpin,

impl UnwindSafe for Term where
B: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<T> Downcast for T where
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> DowncastSync for T where
T: Any + Send + Sync,

source

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

Struct tantivy::Term

Implementations

impl Term

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn typ(&self) -> Type

pub fn field(&self) -> Field

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

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

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

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

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

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

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

pub fn value_bytes(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

Trait Implementations

impl AsMut<Vec<u8, Global>> for Term

fn as_mut(&mut self) -> &mut Vec<u8>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

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

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

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

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

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

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

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

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

fn cmp(&self, other: &Self) -> Ordering

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

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

fn clamp(self, min: Self, max: Self) -> Self

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

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

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

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

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

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

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

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

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

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

Auto Trait Implementations

impl<B> RefUnwindSafe for Term<B> where B: RefUnwindSafe,

impl<B> Send for Term<B> where B: Send,

impl<B> Sync for Term<B> where B: Sync,

impl<B> Unpin for Term<B> where B: Unpin,

impl<B> UnwindSafe for Term<B> where B: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for T where T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

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

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

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

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

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

pub fn value_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn as_mut(&mut self) -> &mut Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

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

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

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

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

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

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

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

impl<B> RefUnwindSafe for Term<B> where
B: RefUnwindSafe,

impl<B> Send for Term<B> where
B: Send,

impl<B> Sync for Term<B> where
B: Sync,

impl<B> Unpin for Term<B> where
B: Unpin,

impl<B> UnwindSafe for Term<B> where
B: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> Fruit for T where
T: Send + Downcast,