Enum ByteRange 

pub enum ByteRange {
    FromTo(u64, u64),
    From(u64),
    Suffix(u64),
}

A single byte range specifier as used in the Range header (RFC 7233 §2.1).

• FromTo(first, last) — a closed byte range first-last (both inclusive).
• From(first) — an open-ended range starting at first.
• Suffix(n) — the last n bytes of the representation.

Variants

FromTo(u64, u64)

A closed byte range: <first>-<last> (both inclusive).

From(u64)

An open-ended byte range: <first>- (from first to end).

Suffix(u64)

A suffix byte range: -<n> (last n bytes).

Implementations

impl ByteRange

pub fn is_valid(&self, length: u64) -> bool

Validate this range against the total length of the resource.

Returns false if:

• FromTo(first, last): first > last or first >= length.
• From(first): first >= length.
• Suffix(n): n == 0.

use api_bones::range::ByteRange;

assert!(ByteRange::FromTo(0, 499).is_valid(1000));
assert!(!ByteRange::FromTo(500, 200).is_valid(1000)); // first > last
assert!(!ByteRange::FromTo(1000, 1999).is_valid(1000)); // first >= length
assert!(ByteRange::Suffix(100).is_valid(1000));
assert!(!ByteRange::Suffix(0).is_valid(1000));

pub fn resolve(&self, length: u64) -> Option<(u64, u64)>

Resolve this range to a (first, last) byte range against the given resource length. Returns None if the range is unsatisfiable.

use api_bones::range::ByteRange;

assert_eq!(ByteRange::FromTo(0, 99).resolve(500), Some((0, 99)));
assert_eq!(ByteRange::From(400).resolve(500), Some((400, 499)));
assert_eq!(ByteRange::Suffix(100).resolve(500), Some((400, 499)));
assert_eq!(ByteRange::Suffix(600).resolve(500), Some((0, 499)));
assert_eq!(ByteRange::FromTo(0, 99).resolve(0), None);

Trait Implementations

impl Clone for ByteRange

fn clone(&self) -> ByteRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteRange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ByteRange

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ByteRange

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

Formats the value using the given formatter.

impl FromStr for ByteRange

type Err = ParseRangeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for ByteRange

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ByteRange

impl StructuralPartialEq for ByteRange