Struct Enum 

pub struct Enum<S = Root, Sub = WithSubfields> { /* private fields */ }

An enum field with a declared variant order (- enum: status + variants: [...]). It is a keyword in every respect — the value ops and (via keyword) the full keyword surface all apply — but its .asc() / .desc() sort by the declared order, not alphabetically.

The order is prebaked into the index: the field carries a .sort subfield whose normalizer maps each variant to its rank, so a bare Ticket::status().asc() is order-correct with no script. A value not in the declared set sorts after the known variants.

A bare enum with no declared variants is a plain Keyword instead (the derive only emits Enum when an order is declared).

Implementations

impl<S, Sub> Enum<S, Sub>

pub fn keyword(&self) -> Keyword<S, Sub>

The underlying Keyword handle — the full exact-string surface (eq/any_of/prefix/wildcard/regexp/fuzzy/exists, plus the subfield accessors when Sub = WithSubfields). The enum adds only the order-aware sort on top.

pub fn eq(&self, value: impl FlussoValue<Keyword>) -> TermQuery<S>

Exact match. Accepts a String/&str or a #[derive(FlussoValue)] keyword enum/newtype — matched against its serde string form.

pub fn any_of( &self, values: impl IntoIterator<Item = impl FlussoValue<Keyword>>, ) -> TermsQuery<S>

Match any of the given values.

pub fn exists(&self) -> Query<S>

The field has a non-null value.

impl<S> Enum<S, WithSubfields>

pub fn at(path: impl Into<String>) -> Self

A handle for an enum whose keyword carries flusso’s auto subfields.

impl<S> Enum<S, NoSubfields>

pub fn leaf(path: impl Into<String>) -> Self

A handle for an enum whose keyword has no auto subfields.

Trait Implementations

impl<S: Clone, Sub: Clone> Clone for Enum<S, Sub>

fn clone(&self) -> Enum<S, Sub>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, Sub: Debug> Debug for Enum<S, Sub>

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

Formats the value using the given formatter.

impl<S: FlussoDocument, Sub> Sortable for Enum<S, Sub>

The declared order sorts on the prebaked .sort subfield (a rank-mapped keyword), nesting-aware like any field sort.

fn asc(&self) -> Sort

Sort ascending.

fn desc(&self) -> Sort

Sort descending.