Struct headers::common::content_range::ContentRange

pub struct ContentRange {
    range: Option<(u64, u64)>,
    complete_length: Option<u64>,
}

Content-Range, described in RFC7233

ABNF

Content-Range       = byte-content-range
                    / other-content-range

byte-content-range  = bytes-unit SP
                      ( byte-range-resp / unsatisfied-range )

byte-range-resp     = byte-range "/" ( complete-length / "*" )
byte-range          = first-byte-pos "-" last-byte-pos
unsatisfied-range   = "*/" complete-length

complete-length     = 1*DIGIT

other-content-range = other-range-unit SP other-range-resp
other-range-resp    = *CHAR

Example

use headers::ContentRange;

// 100 bytes (included byte 199), with a full length of 3,400
let cr = ContentRange::bytes(100..200, 3400).unwrap();

Fields

range: Option<(u64, u64)>

First and last bytes of the range, omitted if request could not be satisfied

complete_length: Option<u64>

Total length of the instance, can be omitted if unknown

Implementations

impl ContentRange

pub fn bytes( range: impl RangeBounds<u64>, complete_length: impl Into<Option<u64>>, ) -> Result<ContentRange, InvalidContentRange>

Construct a new Content-Range: bytes .. header.

pub fn unsatisfied_bytes(complete_length: u64) -> Self

Create a new ContentRange stating the range could not be satisfied.

The passed argument is the complete length of the entity.

pub fn bytes_range(&self) -> Option<(u64, u64)>

Get the byte range if satisified.

Note that these byte ranges are inclusive on both ends.

pub fn bytes_len(&self) -> Option<u64>

Get the bytes complete length if available.

Trait Implementations

impl Clone for ContentRange

fn clone(&self) -> ContentRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentRange

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

Formats the value using the given formatter.

impl Header for ContentRange

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 ContentRange

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