Struct opendal::raw::BytesRange

pub struct BytesRange(_, _);

BytesRange(offset, size) carries a range of content.

BytesRange implements ToString which can be used as Range HTTP header directly.

<unit> should always be bytes.

Range: bytes=<range-start>-
Range: bytes=<range-start>-<range-end>
Range: bytes=-<suffix-length>

Notes

BytesRange support constuct via rust native range syntex like .., 1024.., ..2048. But it’s has different symantic on RangeTo: ..<end>. In rust, ..<end> means all items that < end, but in BytesRange, ..<end> means the tailing part of content, a.k.a, the last <end> bytes of content.

• 0..1024 will be converted to header range: bytes=0-1024
• ..1024 will be converted to header range: bytes=-1024

Implementations

impl BytesRange

pub fn new(offset: Option<u64>, size: Option<u64>) -> Self

Create a new BytesRange

It better to use BytesRange::from(1024..2048) to construct.

Note

The behavior for None and Some(0) is different.

• offset=None => bytes=-<size>, read <size> bytes from end.
• offset=Some(0) => bytes=0-<size>, read <size> bytes from start.

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

Get offset of BytesRange.

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

Get size of BytesRange.

pub fn is_full(&self) -> bool

Check if this range is full of this object content.

If this range is full, we don’t need to specify it in http request.

pub fn to_header(&self) -> String

Convert bytes range into Range header.

NOTE

• bytes=-1023 means get the suffix of the file.
• bytes=0-1023 means get the first 1024 bytes, we must set the end to 1023.

pub fn to_range(&self) -> impl RangeBounds<u64>

Convert bytes range into rust range.

pub fn apply_on_bytes(&self, bs: Bytes) -> Bytes

apply_on_bytes will apply range on bytes.

Trait Implementations

impl Clone for BytesRange

fn clone(&self) -> BytesRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BytesRange

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

Formats the value using the given formatter.

impl Default for BytesRange

fn default() -> BytesRange

Returns the “default value” for a type.

impl Display for BytesRange

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

Formats the value using the given formatter.

impl<T> From<T> for BytesRangewhere
    T: RangeBounds<u64>,

fn from(range: T) -> Self

Converts to this type from the input type.

impl FromStr for BytesRange

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self>

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

impl PartialEq<BytesRange> for BytesRange

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BytesRange

impl Eq for BytesRange

impl StructuralEq for BytesRange

impl StructuralPartialEq for BytesRange