Enum QueryParamReason 

#[non_exhaustive]
pub enum QueryParamReason {
    UnknownColumn,
    UnknownOperator,
    InvalidFieldName,
    InvalidValue,
    NotANumber,
    InvalidCursor,
    TooDeep,
    UnknownRelation,
    NotNumeric,
    UnsupportedOperator,
}

Why a query parameter was refused. The code (as_str) is the stable, snake_case reason clients branch on.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnknownColumn

A column the resource does not have (a filter, a sort or an aggregate names it).

UnknownOperator

A field[operator] filter whose operator is not one of the filter grammar’s.

InvalidFieldName

A parameter that names a field with characters no column carries.

InvalidValue

A value the named column cannot take (not a number, not a UUID, not a date, not one of an enum’s values, out of range).

NotANumber

A paging parameter that is not a whole, non-negative number.

InvalidCursor

A paging position (after, before) that this endpoint did not issue for this sort.

TooDeep

A page beyond the deepest an offset walk may reach.

UnknownRelation

An include/with name that is not a relation of the resource.

NotNumeric

A column the reduction cannot be taken over (sum of a text column).

UnsupportedOperator

An operator the named column’s type does not support (contain on a number).

Implementations

impl QueryParamReason

pub fn as_str(self) -> &'static str

The stable code, as it appears in a violation’s params.reason.

Trait Implementations

impl Clone for QueryParamReason

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for QueryParamReason

impl Debug for QueryParamReason

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

Formats the value using the given formatter.

impl Eq for QueryParamReason

impl PartialEq for QueryParamReason

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for QueryParamReason