Struct headers::Range

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

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 headers::Range;


let range = Range::bytes(0..1234).unwrap();

Implementations

impl Range

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

Creates a Range header from bounds.

pub fn satisfiable_ranges<'a>( &'a self, len: u64, ) -> impl Iterator<Item = (Bound<u64>, Bound<u64>)> + 'a

Iterate the range sets as a tuple of bounds, if valid with length.

The length of the content is passed as an argument, and all ranges that can be satisfied will be iterated.

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a copy 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

Formats the value using the given formatter.

impl Header for Range

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I: Iterator<Item = &'i HeaderValue>>( values: &mut I, ) -> Result<Self, Error>

Decode this type from an iterator of HeaderValues.

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

Encode this type to a HeaderMap.

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