Struct InternalClauses 

pub struct InternalClauses {
    pub primary_key_in_clause: Option<WhereClause>,
    pub primary_key_equal_clause: Option<WhereClause>,
    pub in_clauses: Vec<WhereClause>,
    pub range_clause: Option<WhereClause>,
    pub equal_clauses: BTreeMap<String, WhereClause>,
}

Internal clauses struct

Fields

primary_key_in_clause: Option<WhereClause>

Primary key in clause

primary_key_equal_clause: Option<WhereClause>

Primary key equal clause

in_clauses: Vec<WhereClause>

In clauses, on distinct non-primary-key fields.

The grammar groups any number of them structurally; whether more than one is accepted is a protocol-versioned decision made at path-query lowering (protocol version 14 is the first to accept multiple in clauses, on consecutive index properties).

range_clause: Option<WhereClause>

Range clause.

On an indexOnly document type this may sit on an index’s TERMINAL (member-key) property, not only on an index prefix property — see InternalClauses::classify_fields for the modeled roles instead of assuming property placement.

equal_clauses: BTreeMap<String, WhereClause>

Equal clause

Implementations

impl InternalClauses

pub fn classify_field( document_type: DocumentTypeRef<'_>, field: &str, ) -> ClauseFieldRoles

Classify one field’s index roles against document_type. The single derivation site for “is this a prefix property, a terminal, or $id” — consumers must branch on this instead of assuming a clause sits on an index prefix property (on indexOnly types it may sit on a terminal).

pub fn classify_fields( &self, document_type: DocumentTypeRef<'_>, ) -> BTreeMap<String, ClauseFieldRoles>

Self::classify_field over every field these clauses name — classification happens once, at the seam between clause extraction and routing, instead of being re-derived downstream.

pub fn verify(&self) -> bool

Returns true if the clause is a valid format.

pub fn is_for_primary_key(&self) -> bool

Returns true if the query clause is for primary keys.

pub fn is_empty(&self) -> bool

Returns true if self is empty.

pub fn extract_from_clauses( all_where_clauses: Vec<WhereClause>, platform_version: &PlatformVersion, ) -> Result<Self, Error>

Extracts the WhereClauses and returns them as type InternalClauses.

pub fn validate_against_schema( &self, document_type: DocumentTypeRef<'_>, ) -> QuerySyntaxSimpleValidationResult

Validate this collection of InternalClauses against the document schema

Trait Implementations

impl Clone for InternalClauses

fn clone(&self) -> InternalClauses

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InternalClauses

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

Formats the value using the given formatter.

impl Default for InternalClauses

fn default() -> InternalClauses

Returns the “default value” for a type.

impl From<InternalClauses> for Vec<WhereClause>

fn from(clauses: InternalClauses) -> Self

Converts to this type from the input type.

impl PartialEq for InternalClauses

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