Enum FilterRejection 

pub enum FilterRejection {
    NoBudgetAdvertised,
    TooManyRanges {
        ranges: usize,
        limit: u64,
    },
    RepeatedFilter(u64, u8, Option<u64>),
    Unreadable(RangeFilterError),
}

Why a peer’s request must be answered with REQUEST_ERROR and INVALID_FILTER.

Draft-19 gives the Range Filters four rules and answers every one of them the same way — “MUST be rejected with REQUEST_ERROR with error code INVALID_FILTER” — so this says which rule was broken rather than which code to send. FilterRejection::request_error_code is the code, and it is the same for all four.

None of these is a session close, which is the whole reason the type exists. A rejection is a reply, and a reply names the Request ID of the request it answers, so the endpoint has to have taken the request in order to refuse it. The rejection is recorded against that id and spent by the REQUEST_ERROR that answers it.

Variants

NoBudgetAdvertised

The peer sent a Range Filter and this endpoint advertised no budget.

Section 10.3.1.6: “The default value is 0, so if not specified, the peer MUST NOT send any such filter parameters.” Zero is the default and it means none allowed — the opposite of what zero means in the option beside it, MAX_REQUEST_UPDATES, where it means no limit. The two sit in consecutive subsections and read opposite ways.

TooManyRanges

More Ranges than MAX_FILTER_RANGES allows, counted across every filter.

Fields

ranges: usize

The total the request carried.

limit: u64

The total this endpoint advertised.

RepeatedFilter(u64, u8, Option<u64>)

Two filters with the same Parameter Type, SetID and Property Type.

Repeats of a type are otherwise expected, so the key is the whole triple: “The Track Property filter parameter MAY appear multiple times in a SUBSCRIBE_TRACKS message”

Unreadable(RangeFilterError)

A filter this codec could not read, or one that broke a rule of its own.

Implementations

impl FilterRejection

pub fn request_error_code(&self) -> RequestErrorCode

The REQUEST_ERROR code every one of these is answered with.

Trait Implementations

impl Clone for FilterRejection

fn clone(&self) -> FilterRejection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterRejection

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

Formats the value using the given formatter.

impl Display for FilterRejection

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

Formats the value using the given formatter.

impl Eq for FilterRejection

impl Error for FilterRejection

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 From<RangeFilterError> for FilterRejection

fn from(source: RangeFilterError) -> Self

Converts to this type from the input type.

impl PartialEq for FilterRejection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FilterRejection