Struct tantivy::schema::Facet

pub struct Facet(/* private fields */);

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 with any number of facets. The hierarchy implicitly 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.

Implementations

impl Facet

pub fn root() -> Facet

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

pub fn is_root(&self) -> bool

Returns true if 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>(path: &T) -> Result<Facet, FacetParseError>

where T: ?Sized + AsRef<str>,

Parse a text representation of a facet.

If one of the segments of this path contains a /, it should be escaped using an anti-slash \.

pub fn from_path<Path>(path: Path) -> Facet

where Path: IntoIterator, Path::Item: AsRef<str>,

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 if other is a strict subfacet of self.

Disclaimer: By strict we mean that the relation is not reflexive. /happy is not a prefix of /happy.

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

Extract path from the Facet.

pub fn to_path_string(&self) -> String

This function is the inverse of Facet::from(&str).

Trait Implementations

impl BinarySerializable for Facet

fn serialize<W: Write + ?Sized>(&self, writer: &mut W) -> Result<()>

Serialize

fn deserialize<R: Read>(reader: &mut R) -> Result<Self>

Deserialize

fn num_bytes(&self) -> u64

impl Borrow<str> for Facet

fn borrow(&self) -> &str

Immutably borrows from an owned value.

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

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

Formats the value using the given formatter.

impl Default for Facet

fn default() -> Facet

Returns the “default value” for a type.

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.

impl Display for Facet

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<Facet> for OwnedValue

fn from(facet: Facet) -> OwnedValue

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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 PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &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 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 ValueDeserialize for Facet

fn deserialize<'de, D>(deserializer: D) -> Result<Self, DeserializeError>

where D: ValueDeserializer<'de>,

Attempts to deserialize Self from a given value deserializer.

impl Eq for Facet

impl StructuralPartialEq for Facet