Struct FilterParams 

pub struct FilterParams {
    pub filters: Vec<FilterEntry>,
}

Query parameters for structured filtering on a collection endpoint.

Each entry is a field/operator/value triple. Multiple entries are AND-combined by convention; consumers may choose different semantics.

{"filters": [{"field": "status", "operator": "eq", "value": "active"}]}

Fields

filters: Vec<FilterEntry>

The list of filter entries.

Implementations

impl FilterParams

pub fn new(filters: impl IntoIterator<Item = FilterEntry>) -> Self

Create filter params from an iterator of entries.

Examples

use api_bones::query::{FilterParams, FilterEntry};

let f = FilterParams::new([FilterEntry::new("status", "eq", "active")]);
assert!(!f.is_empty());
assert_eq!(f.filters.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if no filters are set.

Examples

use api_bones::query::FilterParams;

let f = FilterParams::default();
assert!(f.is_empty());

Trait Implementations

impl Clone for FilterParams

fn clone(&self) -> FilterParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterParams

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

Formats the value using the given formatter.

impl Default for FilterParams

fn default() -> FilterParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FilterParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FilterParams

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FilterParams

impl StructuralPartialEq for FilterParams