Enum ContentRange 

pub enum ContentRange {
    Bytes {
        first: u64,
        last: u64,
        complete_length: Option<u64>,
    },
    Unsatisfiable {
        complete_length: u64,
    },
}

The Content-Range response header (RFC 7233 §4.2).

Indicates which portion of a resource’s representation is included in the response body.

use api_bones::range::ContentRange;

let cr = ContentRange::bytes(0, 999, Some(5000));
assert_eq!(cr.to_string(), "bytes 0-999/5000");

let cr_unknown = ContentRange::bytes_unknown_length(200, 299);
assert_eq!(cr_unknown.to_string(), "bytes 200-299/*");

let cr_unsatisfied = ContentRange::unsatisfiable(5000);
assert_eq!(cr_unsatisfied.to_string(), "bytes */5000");

Variants

Bytes

A satisfiable byte range: bytes <first>-<last>/<complete-length or *>.

Fields

first: u64

First byte position (inclusive).

last: u64

Last byte position (inclusive).

complete_length: Option<u64>

Total length of the representation, or None if unknown (*).

Unsatisfiable

An unsatisfiable range: bytes */<complete-length>.

Fields

complete_length: u64

Total length of the representation.

Implementations

impl ContentRange

pub fn bytes(first: u64, last: u64, complete_length: Option<u64>) -> Self

Construct a satisfiable byte range with a known total length.

pub fn bytes_unknown_length(first: u64, last: u64) -> Self

Construct a satisfiable byte range where the total length is unknown.

pub fn unsatisfiable(complete_length: u64) -> Self

Construct an unsatisfiable response (bytes */<complete-length>).

Use this when the Range header cannot be satisfied; pair it with a 416 Range Not Satisfiable status code.

Trait Implementations

impl Clone for ContentRange

fn clone(&self) -> ContentRange

Returns a duplicate 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<'de> Deserialize<'de> for ContentRange

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ContentRange

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

Formats the value using the given formatter.

impl FromStr for ContentRange

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a Content-Range header value.

Accepts bytes <first>-<last>/<length>, bytes <first>-<last>/*, and bytes */<length>.

use api_bones::range::ContentRange;

let cr: ContentRange = "bytes 0-999/5000".parse().unwrap();
assert_eq!(cr, ContentRange::bytes(0, 999, Some(5000)));

let cr: ContentRange = "bytes */5000".parse().unwrap();
assert_eq!(cr, ContentRange::unsatisfiable(5000));

type Err = ParseRangeError

The associated error which can be returned from parsing.

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 Serialize for ContentRange

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ContentRange

impl StructuralPartialEq for ContentRange