Struct SequenceSet 

pub struct SequenceSet(/* private fields */);

A validated IMAP sequence-set string.

RFC 3501 Section 9 formal syntax:

sequence-set    = (seq-number / seq-range) *("," sequence-set)
seq-number      = nz-number / "*"
seq-range       = seq-number ":" seq-number
nz-number       = digit-nz *DIGIT      ; non-zero unsigned 32-bit integer

RFC 5182 Section 5 extends the grammar with "$" as a standalone element referencing saved search results.

Construction validates the full ABNF and rejects empty, malformed, or overflowing values.

Implementations

impl SequenceSet

pub fn into_inner(self) -> String

Consumes the wrapper and returns the inner string.

pub fn new(s: impl Into<String>) -> Result<Self, ValidationError>

Create a general sequence set (allows * and $).

Validates the input against RFC 3501 Section 9 sequence-set ABNF, extended by RFC 5182 Section 5 for $.

pub fn new_known(s: impl Into<String>) -> Result<Self, ValidationError>

Create a “known” sequence set that rejects * and $.

Used for QRESYNC known-uids and seq-match-data where the wildcard * is explicitly disallowed (RFC 7162 Section 3.2.5.2) and $ (RFC 5182 search result reference) is not meaningful.

pub fn as_str(&self) -> &str

Return the inner string.

Trait Implementations

impl AsRef<str> for SequenceSet

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SequenceSet

fn clone(&self) -> SequenceSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SequenceSet

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

Formats the value using the given formatter.

impl Display for SequenceSet

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

Formats the sequence set as its wire representation (RFC 3501 Section 9).

impl From<SequenceSet> for String

fn from(s: SequenceSet) -> Self

Converts to this type from the input type.

impl Hash for SequenceSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SequenceSet

fn eq(&self, other: &SequenceSet) -> 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 TryFrom<&str> for SequenceSet

fn try_from(s: &str) -> Result<Self, Self::Error>

Convert from &str, validating per RFC 3501 Section 9.

type Error = ValidationError

The type returned in the event of a conversion error.

impl TryFrom<String> for SequenceSet

fn try_from(s: String) -> Result<Self, Self::Error>

Convert from String, validating per RFC 3501 Section 9.

type Error = ValidationError

The type returned in the event of a conversion error.

impl Eq for SequenceSet

impl StructuralPartialEq for SequenceSet