Struct QueryOptions 

pub struct QueryOptions {
    pub sort: Vec<(String, SortDir)>,
    pub limit: Option<usize>,
    pub offset: usize,
}

Decoded query options.

Sort is an ordered list of (field, dir) pairs; the wire encodes it as a JSON array so key/priority order is preserved (a JSON object would lose order through serde_json’s map decode).

Fields

sort: Vec<(String, SortDir)>

limit: Option<usize>

offset: usize

Implementations

impl QueryOptions

pub fn parse(options_json: Option<&str>) -> Result<Self, NookError>

Parses an optional wire optionsJson. None/empty → default.

Errors

Returns NookError::InvalidArg if the JSON is malformed or a value is out of range (negative / fractional limit/offset, bad dir).

pub fn has_sort(&self) -> bool

true when no sort keys are set.

pub fn validate_sort_fields<'f>( &self, field_ty: impl Fn(&str) -> Option<&'f FieldType>, ) -> Result<(), NookError>

Validates that every sort field exists and is orderable (not an array). Callers that sort (apply) AND callers that ignore sort but must reject an invalid spec (count) both run this, so the accept/reject decision is identical across read ops.

Errors

NookError::Schema if a sort field is unknown or non-orderable.

pub fn apply<'f>( &self, docs: Vec<Value>, id_field: &str, field_ty: impl Fn(&str) -> Option<&'f FieldType>, ) -> Result<Vec<Value>, NookError>

Orders docs in place by the configured sort keys, then applies offset/limit. Comparison is schema-typed via field_ty (a lookup field name → Option<&FieldType>). null/missing values sort LAST regardless of direction; ties break by id_field (ascending) for deterministic pagination.

Errors

NookError::Schema if a sort field is unknown or its type is not orderable (array).

Trait Implementations

impl Clone for QueryOptions

fn clone(&self) -> QueryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryOptions

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

Formats the value using the given formatter.

impl Default for QueryOptions

fn default() -> QueryOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryOptions

where QueryOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.