Enum actix_web::http::header::Range

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

Range header, defined in RFC 7233 §3.1

The “Range” header field on a GET request modifies the method semantics to request transfer of only one or more sub-ranges 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]
suffix-byte-range-spec = "-" suffix-length
suffix-length = 1*DIGIT
first-byte-pos = 1*DIGIT
last-byte-pos = 1*DIGIT

Example Values

• bytes=1000-
• bytes=-50
• bytes=0-1,30-40
• bytes=0-10,20-90,-100
• custom_unit=0-123
• custom_unit=xxx-yyy

Examples

use actix_web::http::header::{Range, ByteRangeSpec};
use actix_web::HttpResponse;

let mut builder = HttpResponse::Ok();
builder.insert_header(Range::Bytes(
    vec![ByteRangeSpec::FromTo(1, 100), ByteRangeSpec::From(200)]
));
builder.insert_header(Range::Unregistered("letters".to_owned(), "a-f".to_owned()));
builder.insert_header(Range::bytes(1, 100));
builder.insert_header(Range::bytes_multi(vec![(1, 100), (200, 300)]));

Variants

Bytes(Vec<ByteRangeSpec>)

Tuple Fields

0: Vec<ByteRangeSpec>

Byte range.

Unregistered(String, String)

Tuple Fields

0: String

1: String

Custom range, with unit not registered at IANA.

(other-range-unit: String , other-range-set: String)

Implementations

impl Range

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

Constructs a common byte range header.

Eg: bytes=from-to

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

Constructs a byte range header with multiple subranges.

Eg: bytes=from1-to1,from2-to2,fromX-toX

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

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

Formats the value using the given formatter.

impl FromStr for Range

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Header for Range

fn name() -> HeaderName

Returns the name of the header field

fn parse<T: HttpMessage>(msg: &T) -> Result<Self, ParseError>

Parse a header

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

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.

fn try_into_value(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a HeaderValue.

impl StructuralPartialEq for Range