Enum RangeFilterError 

pub enum RangeFilterError {
    NotARangeFilter(u64),
    Malformed {
        detail: &'static str,
    },
    DeltaOverflow {
        base: u64,
        delta: u64,
    },
    PriorityAboveTheField(u64),
    PropertyTypeIsNotAnInteger(u64),
}

A Range Filter value this codec could not turn into ranges.

Kept out of CodecError on purpose, and the absence of a From impl is the mechanism: draft-19 answers every one of these with a REQUEST_ERROR carrying INVALID_FILTER, which is a message the endpoint sends after decoding the request, so none of them may become a decoder refusal. See this module’s header.

Variants

NotARangeFilter(u64)

A parameter type outside 0x25 through 0x29 was handed to the reader.

Malformed

The value ran out before a field the shape requires.

Fields

detail: &'static str

Which field was missing, for a log that says what was short.

DeltaOverflow

A delta resolved past the end of the 64-bit space.

“Any delta encoding that results in a value that exceeds 2^64-1 MUST be rejected with REQUEST_ERROR with error code INVALID_FILTER.” The sum is checked rather than allowed to wrap: a wrapped Start is a small number, and a filter that reads as 0-5 when its sender wrote something above the end of the space passes Objects it was written to exclude.

Fields

base: u64

The value the delta was counted from.

delta: u64

The delta as it arrived.

PriorityAboveTheField(u64)

A PRIORITY_FILTER range names a value the field cannot hold.

Section 10.2.12: “If a decoded value exceeds 255, the endpoint MUST reject this with REQUEST_ERROR with error code INVALID_FILTER since Publisher Priority is an 8-bit field.”

“A decoded value”, so the resolved Start or End rather than the delta that spelled it — a filter of 200 to 300 has both deltas well inside the byte and one endpoint outside it.

PropertyTypeIsNotAnInteger(u64)

A property filter names a Property Type that is not an integer-valued one.

Draft-19 Section 10.2.13 and draft-19 Section 10.2.14 say the same of both: the filter selects a range “for a required Object Property Type which MUST be even, i.e. a single integer value (see Figure 2), otherwise the endpoint MUST reject this with REQUEST_ERROR with error code INVALID_FILTER”.

The parity is the Key-Value-Pair convention doing the work: an even Type carries a bare varint and an odd one carries length-prefixed bytes, so an odd Property Type is a property whose value is not a number and a range over it has nothing to compare.

Trait Implementations

impl Clone for RangeFilterError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RangeFilterError

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

Formats the value using the given formatter.

impl Display for RangeFilterError

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

Formats the value using the given formatter.

impl Eq for RangeFilterError

impl Error for RangeFilterError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for RangeFilterError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RangeFilterError