Struct tantivy::schema::Facet

pub struct Facet(_);

A Facet represent a point in a given hierarchy.

They are typically represented similarly to a filepath. For instance, an e-commerce website could have a Facet for /electronics/tv_and_video/led_tv.

A document can be associated to any number of facets. The hierarchy implicitely imply that a document belonging to a facet also belongs to the ancestor of its facet. In the example above, /electronics/tv_and_video/ and /electronics.

Methods

impl Facet

pub fn root() -> Facet

Returns a new instance of the "root facet" Equivalent to /.

pub fn is_root(&self) -> bool

Returns true iff the facet is the root facet /.

pub fn encoded_str(&self) -> &str

Returns a binary representation of the facet.

In this representation, 0u8 is used as a separator and the string parts of the facet are unescaped. (The first / is not encoded at all).

This representation has the benefit of making it possible to express "being a child of a given facet" as a range over the term ordinals.

pub fn from_encoded(encoded_bytes: Vec<u8>) -> Result<Facet, FromUtf8Error>

Creates a Facet from its binary representation.

pub fn from_text<T: ?Sized>(path: &T) -> Facet where
    T: AsRef<str>, 

Parse a text representation of a facet.

It is conceptually, if one of the steps of this path contains a / or a \, it should be escaped using an anti-slash /.

pub fn from_path<Path>(path: Path) -> Facet where
    Path: IntoIterator,
    Path::Item: ToString, 

Returns a Facet from an iterator over the different steps of the facet path.

The steps are expected to be unescaped.

pub fn is_prefix_of(&self, other: &Facet) -> bool

Returns true iff other is a subfacet of self.

pub fn to_path(&self) -> Vec<&str>

Extract path from the Facet.

Trait Implementations

impl<'a, T: ?Sized + AsRef<str>> From<&'a T> for Facet

fn from(path_asref: &'a T) -> Facet

Performs the conversion.

impl<'a> From<Facet> for Value

fn from(facet: Facet) -> Value

Performs the conversion.

impl Clone for Facet

fn clone(&self) -> Facet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Facet

impl Ord for Facet

fn cmp(&self, other: &Facet) -> 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.

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

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

Restrict a value to a certain interval.

impl PartialEq<Facet> for Facet

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

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

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

This method tests for !=.

impl PartialOrd<Facet> for Facet

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

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

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

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

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

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

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

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

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

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

impl Display for Facet

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

Formats the value using the given formatter.

impl Debug for Facet

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

Formats the value using the given formatter.

impl Hash for Facet

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 StructuralPartialEq for Facet

impl StructuralEq for Facet

impl Borrow<str> for Facet

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Serialize for Facet

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Facet

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.