Struct DocumentRankedMode 

pub struct DocumentRankedMode {
    pub axis: RankedAxis,
    pub descending: bool,
    pub k: u16,
    pub offset: u32,
    pub group_by_property: String,
    pub aggregate_field: String,
    pub prefix_pins: Vec<PrefixPin>,
}

The resolved shape of a ranked request: which axis, which direction, how many groups, and the (group property, aggregate field) pair the index picker needs.

Produced by mode_detection::detect_ranked_mode from the caller’s (select, group_by, order_by, limit, offset) inputs. Parallels super::drive_document_count_query::DocumentCountMode in role — the versioned classification of a request — but carries data rather than being a bare discriminant, because the ranked surface has exactly one executor pair (no-proof / proof) and all of its variation is in these values.

Not Eq: the prefix pins carry [Value]s, whose float variant keeps the type at PartialEq.

Fields

axis: RankedAxis

The ranking axis, from the SELECT function.

descending: bool

Walk direction: ORDER BY … DESC ⇒ true, ASC ⇒ false.

k: u16

Number of groups requested — the LIMIT, 1 ..= MAX_RANKED_LIMIT.

offset: u32

Ranks to skip — the OFFSET, 0 when unset.

group_by_property: String

The single GROUP BY property; must be the covering ranked index’s last property.

aggregate_field: String

The field the aggregate applies to. Empty for RankedAxis::Count (COUNT(*)); the index’s summable property for RankedAxis::Sum / RankedAxis::Avg.

prefix_pins: Vec<PrefixPin>

The where prefix pins — one PrefixPin per clause, exactly one per leading property of the covering compound index, in whatever order the request supplied them (the resolver re-orders them into index-property order when it encodes the path). A pin normally carries one value (an == clause); at most one carries several (the single permitted branching IN). Empty for the single-property form. Shape-validated only: the index-aware checks (does a compound index exist whose leading properties these pin?) live in index_picker.

Trait Implementations

impl Clone for DocumentRankedMode

fn clone(&self) -> DocumentRankedMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentRankedMode

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

Formats the value using the given formatter.

impl PartialEq for DocumentRankedMode

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