Struct Range 

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

Available on crate features http and std only.

Range header, defined in RFC7233

The “Range” header field on a GET request modifies the method semantics to request transfer of only one or more subranges of the selected representation data, rather than the entire selected representation data.

ABNF

Range = byte-ranges-specifier / other-ranges-specifier
other-ranges-specifier = other-range-unit "=" other-range-set
other-range-set = 1*VCHAR

bytes-unit = "bytes"

byte-ranges-specifier = bytes-unit "=" byte-range-set
byte-range-set = 1#(byte-range-spec / suffix-byte-range-spec)
byte-range-spec = first-byte-pos "-" [last-byte-pos]
first-byte-pos = 1*DIGIT
last-byte-pos = 1*DIGIT

Example values

• bytes=1000-
• bytes=-2000
• bytes=0-1,30-40
• bytes=0-10,20-90,-100

Examples

use rama_http_headers::Range;

// A client asking for the last 500 bytes of a representation.
let range = Range::suffix(500);

// Resolve against a known content length into the inclusive
// `(first, last)` byte range to serve. `None` would mean `416`.
assert_eq!(range.first_satisfiable_range(2000), Some((1500, 1999)));

Implementations

impl Range

pub fn bytes(bounds: impl RangeBounds<u64>) -> Result<Range, InvalidRange>

Creates a Range header from bounds (e.g. 0..100, 0..=99, 100..).

A range open at the start does not map to a bytes= spec; use Range::suffix for the suffix (bytes=-N) form instead.

pub fn suffix(n: u64) -> Range

Creates a suffix Range header (bytes=-n) requesting the final n bytes of the selected representation.

pub fn iter(&self) -> impl Iterator<Item = ByteRangeSpec>

Iterate over the ByteRangeSpecs in this header.

Syntactically invalid specs (and the empty entries that a stray comma produces) are silently skipped, matching how servers tolerate them.

pub fn satisfiable_ranges( &self, content_length: u64, ) -> impl Iterator<Item = (u64, u64)>

Resolve every satisfiable range against a known content_length.

Each yielded (first, last) is inclusive and clamped to the representation; unsatisfiable specs are dropped. See ByteRangeSpec::to_satisfiable_range.

pub fn first_satisfiable_range(&self, content_length: u64) -> Option<(u64, u64)>

Resolve the first satisfiable range against a known content_length.

This is the common case for single-range byte serving: it returns the inclusive (first, last) to serve, or None (⇒ 416 Range Not Satisfiable) when no spec in the header can be satisfied.

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Range

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

Formats the value using the given formatter.

impl Eq for Range

impl Hash for Range

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

where __H: Hasher,

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 HeaderDecode for Range

fn decode<'i, I>(values: &mut I) -> Result<Range, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for Range

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl PartialEq for Range

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

impl TypedHeader for Range

fn name() -> &'static HeaderName

The name of this header.