Struct GetItemsOptions

pub struct GetItemsOptions { /* private fields */ }

Options for requests to endpoints that return multiple items.

Implementations

impl GetItemsOptions

pub fn new() -> Self

Creates an empty option set.

pub fn filter_eq( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is equal to the given value.

field can be a simple or dotted field name, like author or author.name. value can be a bare number or string (like 2 or Ben), or a stringified JSON value ("2.0", [1, 2], {"checked": true}).

pub fn filter_not( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is not equal to the given value.

pub fn filter_contains( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is an array that contains the given value. If value is a stringified JSON array, the field must contain all its elements.

pub fn filter_lt( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is strictly less than the given value.

pub fn filter_gt( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is strictly greater than the given value.

pub fn filter_max( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is less than or equal to the given value.

pub fn filter_min( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is greater than or equal to the given value.

pub fn filter_like( &mut self, field: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets an option to only return items whose field is a string that contains the substring value. value can contain * wildcards.

pub fn filter_has(&mut self, field: impl Into<String>) -> &mut Self

Sets an option to only return items that have the given field.

pub fn filter_has_not(&mut self, field: impl Into<String>) -> &mut Self

Sets an option to only return items that do not have the given field.

pub fn sort(&mut self, field: impl Into<String>, order: SortOrder) -> &mut Self

Sets an option to return items in order for the given field.

pub fn field(&mut self, field: impl Into<String>) -> &mut Self

Sets an option to only return the given field of each item.

The special id and last_modified fields are always returned.

pub fn limit(&mut self, count: u64) -> &mut Self

Sets the option to return at most count items.

pub fn iter_query_pairs( &self, ) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>

Returns an iterator of (name, value) query pairs for these options.

Trait Implementations

impl Clone for GetItemsOptions

fn clone(&self) -> GetItemsOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetItemsOptions

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

Formats the value using the given formatter.

impl Default for GetItemsOptions

fn default() -> GetItemsOptions

Returns the “default value” for a type.

impl Hash for GetItemsOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GetItemsOptions

fn cmp(&self, other: &GetItemsOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GetItemsOptions

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

fn partial_cmp(&self, other: &GetItemsOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for GetItemsOptions

impl StructuralPartialEq for GetItemsOptions