Struct tantivy_fst::raw::Output

pub struct Output(_);

An output is a value that is associated with a key in a finite state transducer.

Note that outputs must satisfy an algebra. Namely, it must have an additive identity and the following binary operations defined: prefix, concatenation and subtraction. prefix and concatenation are commutative while subtraction is not. subtraction is only defined on pairs of operands where the first operand is greater than or equal to the second operand.

Currently, output values must be u64. However, in theory, an output value can be anything that satisfies the above algebra. Future versions of this crate may make outputs generic on this algebra.

Methods

impl Output

pub fn new(v: u64) -> Output

Create a new output from a u64.

pub fn zero() -> Output

Create a zero output.

pub fn value(self) -> u64

Retrieve the value inside this output.

pub fn is_zero(self) -> bool

Returns true if this is a zero output.

pub fn prefix(self, o: Output) -> Output

Returns the prefix of this output and o.

pub fn cat(self, o: Output) -> Output

Returns the concatenation of this output and o.

pub fn sub(self, o: Output) -> Output

Returns the subtraction of o from this output.

This function panics if self > o.

Trait Implementations

impl PartialEq<Output> for Output

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

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

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

This method tests for !=.

impl Ord for Output

fn cmp(&self, other: &Output) -> 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 Clone for Output

fn clone(&self) -> Output

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Output

impl Copy for Output

impl PartialOrd<Output> for Output

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

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

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

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

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

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

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

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

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

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

impl Hash for Output

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, 

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

impl Debug for Output

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

Formats the value using the given formatter.