Struct Indicators 

pub struct Indicators { /* private fields */ }

The push feature-capability indicators one Feature-Caps value carries (§8.2).

RFC 6809 §4 gives the header the shape * followed by ;-separated indicators, and RFC 8599 §8.2 registers three of them that a client cares about. Indicators belonging to other mechanisms are ignored rather than rejected — that is what an extensible list is for, and a parser that failed on an unknown one would break against every proxy that grows a feature.

This models one value. A registrar may send several, on one row or on several; read them with crate::message::Headers::typed_all, which treats those two spellings as the same message.

Implementations

impl Indicators

pub fn pns(&self) -> Option<&[u8]>

The push notification service this value names (§8.2’s sip.pns).

This is the answer to “does this registrar support the service I asked for”. A registrar naming a different one has not refused the registration — it has accepted a binding that nothing will ever wake, which is worse, because it looks like success.

pub fn refreshes_required(&self) -> bool

Whether the registrar asked for binding refreshes even in the absence of a push (§8.2’s sip.pnsreg).

Presence is a fact of its own, separate from the interval: an indicator sent with a value this side cannot read still says the registrar wants refreshes, and treating it as absent would let the binding lapse.

pub fn refresh_interval(&self) -> Option<Duration>

How long the registrar said to leave between those refreshes (§8.2’s sip.pnsreg).

None when the indicator is absent and when its value is not a number of seconds; see Indicators::refreshes_required for the difference.

pub fn purr(&self) -> Option<&[u8]>

The PURR the proxy assigned this binding (§8.2’s sip.pnspurr).

pub fn is_empty(&self) -> bool

Whether this value said nothing about push at all.

Trait Implementations

impl Clone for Indicators

fn clone(&self) -> Indicators

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Indicators

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

Formats the value using the given formatter.

impl Default for Indicators

fn default() -> Indicators

Returns the “default value” for a type.

impl PartialEq for Indicators

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

fn decode(value: &[u8]) -> Result<Self, HeaderError>

Decodes the first value in the row; use crate::message::Headers::typed_all when every one is needed.

const NAME: HeaderName = HeaderName::FeatureCaps

The header this type reads.

fn decode_list(value: &[u8]) -> Result<Vec<Self>, HeaderError>

Parse every value in one header row.

const VALIDATE_LIST: bool = false

Whether Headers::typed_all must collect and validate the complete field before yielding.

fn validate_list(_values: &[&Self]) -> Result<(), HeaderError>

Validate all decoded values of this field across the complete message.

impl Eq for Indicators

impl StructuralPartialEq for Indicators