Enum tantivy_columnar::Cardinality

#[repr(u8)]
pub enum Cardinality {
    Full = 0,
    Optional = 1,
    Multivalued = 2,
}

Enum describing the number of values that can exist per document (or per row if you will).

The cardinality must fit on 2 bits.

Variants

Full = 0

All documents contain exactly one value. Full is the default for auto-detecting the Cardinality, since it is the most strict.

Optional = 1

All documents contain at most one value.

Multivalued = 2

All documents may contain any number of values.

Implementations

impl Cardinality

pub fn is_optional(&self) -> bool

pub fn is_multivalue(&self) -> bool

pub fn is_full(&self) -> bool

Trait Implementations

impl BinarySerializable for Cardinality

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 Clone for Cardinality

fn clone(&self) -> Cardinality

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cardinality

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

Formats the value using the given formatter.

impl Default for Cardinality

fn default() -> Cardinality

Returns the “default value” for a type.

impl Display for Cardinality

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

Formats the value using the given formatter.

impl Hash for Cardinality

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 Cardinality

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

fn eq(&self, other: &Cardinality) -> 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 Cardinality

fn partial_cmp(&self, other: &Cardinality) -> 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 Copy for Cardinality

impl Eq for Cardinality

impl StructuralPartialEq for Cardinality