Struct sg_index_query::QueryOptions

pub struct QueryOptions<T> {
    pub limit: Option<u32>,
    pub descending: Option<bool>,
    pub min: Option<QueryBound<T>>,
    pub max: Option<QueryBound<T>>,
}

QueryOptions are used to pass in options to a query function

Fields

limit: Option<u32>

The number of items that will be returned

descending: Option<bool>

Whether to sort items in ascending or descending order

min: Option<QueryBound<T>>

The minimum key value to fetch

max: Option<QueryBound<T>>

The maximum key value to fetch

Implementations

impl<T> QueryOptions<T>

pub fn unpack<'a, U: PrimaryKey<'a>>( &self, offset_to_bound_fn: &dyn Fn(&T) -> U, default_query_limit: Option<u32>, max_query_limit: Option<u32> ) -> QueryOptionsInternal<'a, U>

Trait Implementations

impl<T: Clone> Clone for QueryOptions<T>

fn clone(&self) -> QueryOptions<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for QueryOptions<T>

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

Formats the value using the given formatter.

impl<T> Default for QueryOptions<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for QueryOptions<T>where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: JsonSchema> JsonSchema for QueryOptions<T>

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T: PartialEq> PartialEq<QueryOptions<T>> for QueryOptions<T>

fn eq(&self, other: &QueryOptions<T>) -> 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<T> Serialize for QueryOptions<T>where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for QueryOptions<T>