Enum websocket::header::Range

pub enum Range {
    Bytes(Vec<ByteRangeSpec>),
    Unregistered(String, String),
}

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
• custom_unit=0-123
• custom_unit=xxx-yyy

Examples

use hyper::header::{Headers, Range, ByteRangeSpec};

let mut headers = Headers::new();
headers.set(Range::Bytes(
    vec![ByteRangeSpec::FromTo(1, 100), ByteRangeSpec::AllFrom(200)]
));

headers.clear();
headers.set(Range::Unregistered("letters".to_owned(), "a-f".to_owned()));

use hyper::header::{Headers, Range};

let mut headers = Headers::new();
headers.set(Range::bytes(1, 100));

headers.clear();
headers.set(Range::bytes_multi(vec![(1, 100), (200, 300)]));

Variants

Bytes(Vec<ByteRangeSpec>)

Byte range

Unregistered(String, String)

Custom range, with unit not registered at IANA (other-range-unit: String , other-range-set: String)

Methods

impl Range

pub fn bytes(from: u64, to: u64) -> Range

Get the most common byte range header ("bytes=from-to")

pub fn bytes_multi(ranges: Vec<(u64, u64)>) -> Range

Get byte range header with multiple subranges ("bytes=from1-to1,from2-to2,fromX-toX")

Trait Implementations

impl Debug for Range

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

Formats the value using the given formatter.

impl Display for Range

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

Formats the value using the given formatter.

impl FromStr for Range

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Range, Error>

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

impl PartialEq<Range> for Range

fn eq(&self, other: &Range) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Range) -> bool

This method tests for !=.

impl HeaderFormat for Range

fn fmt_header(&self, f: &mut Formatter) -> Result<(), Error>

Format a header to be output into a TcpStream.

impl Header for Range

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header(raw: &[Vec<u8>]) -> Result<Range, Error>

Parse a header from a raw stream of bytes.

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.