Struct Facets 

pub struct Facets { /* private fields */ }

Configuration specifying which fields should be indexed.

Facets are used as part of the cache key for file indexes, since different field selections produce different indexes.

Serialization

Facets serializes as a sequence of field name strings. The precomputed hash is NOT serialized - it is recomputed during deserialization to maintain the invariant that precomputed_hash == hash(fields).

Implementations

impl Facets

pub fn new(facets: &[String]) -> Self

pub fn iter(&self) -> impl Iterator<Item = &FieldName>

Returns an iterator over the facet field names

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

Returns the facet fields as a slice

pub fn len(&self) -> usize

Returns the number of facet fields

pub fn is_empty(&self) -> bool

Returns true if there are no facet fields

pub fn precomputed_hash(&self) -> u64

Trait Implementations

impl Clone for Facets

fn clone(&self) -> Facets

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Facets

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Facets

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Facets

impl Hash for Facets

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 PartialEq for Facets

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Facets

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

where S: Serializer,

Serialize this value into the given Serde serializer.