Enum zarrs::byte_range::ByteRange

pub enum ByteRange {
    FromStart(ByteOffset, Option<ByteLength>),
    FromEnd(ByteOffset, Option<ByteLength>),
}

A byte range.

Variants

FromStart(ByteOffset, Option<ByteLength>)

A byte range from the start.

If the byte length is None, reads to the end of the value.

FromEnd(ByteOffset, Option<ByteLength>)

A byte range from the end.

If the byte length is None, reads to the start of the value.

Implementations

impl ByteRange

pub fn start(&self, size: u64) -> u64

Return the start of a byte range. size is the size of the entire bytes.

pub fn end(&self, size: u64) -> u64

Return the exclusive end of a byte range. size is the size of the entire bytes.

pub const fn offset(&self) -> u64

Return the internal offset of the byte range (which can be at its start or end).

pub fn length(&self, size: u64) -> u64

Return the length of a byte range. size is the size of the entire bytes.

pub fn to_range(&self, size: u64) -> Range<u64>

Convert the byte range to a Range<u64>.

pub fn to_range_usize(&self, size: u64) -> Range<usize>

Convert the byte range to a Range<usize>.

Panics

Panics if the byte range exceeds usize::MAX.

Trait Implementations

impl Clone for ByteRange

fn clone(&self) -> ByteRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteRange

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

Formats the value using the given formatter.

impl Display for ByteRange

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

Formats the value using the given formatter.

impl PartialEq for ByteRange

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

impl Eq for ByteRange

impl StructuralPartialEq for ByteRange