Struct hls_m3u8::tags::ExtXByteRange

pub struct ExtXByteRange(_);

Indicates that a MediaSegment is a sub-range of the resource identified by its URI.

Example

Constructing an ExtXByteRange:

assert_eq!(ExtXByteRange::from(22..55), ExtXByteRange::from(22..=54));

It is also possible to omit the start, in which case it assumes that the ExtXByteRange starts at the byte after the end of the previous ExtXByteRange or 0 if there is no previous one.

assert_eq!(ExtXByteRange::from(..55), ExtXByteRange::from(..=54));

Implementations

impl ExtXByteRange

pub fn saturating_add(self, num: usize) -> Self

Adds num to the start and end of the range.

Example

let range = ExtXByteRange::from(10..22);
let nrange = range.saturating_add(5);

assert_eq!(nrange.len(), range.len());
assert_eq!(nrange.start(), range.start().map(|c| c + 5));

Overflow

If the range is saturated it will not overflow and instead stay at it’s current value.

let range = ExtXByteRange::from(5..usize::max_value());

// this would cause the end to overflow
let nrange = range.saturating_add(1);

// but the range remains unchanged
assert_eq!(range, nrange);

Note

The length of the range will remain unchanged, if the start is Some.

pub fn saturating_sub(self, num: usize) -> Self

Subtracts num from the start and end of the range.

Example

let range = ExtXByteRange::from(10..22);
let nrange = range.saturating_sub(5);

assert_eq!(nrange.len(), range.len());
assert_eq!(nrange.start(), range.start().map(|c| c - 5));

Underflow

If the range is saturated it will not underflow and instead stay at it’s current value.

let range = ExtXByteRange::from(0..10);

// this would cause the start to underflow
let nrange = range.saturating_sub(1);

// but the range remains unchanged
assert_eq!(range, nrange);

Note

The length of the range will remain unchanged, if the start is Some.

pub const fn as_byte_range(&self) -> &ByteRange

Returns a shared reference to the underlying ByteRange.

Example

use hls_m3u8::types::ByteRange;

assert_eq!(
    ExtXByteRange::from(2..11).as_byte_range(),
    &ByteRange::from(2..11)
);

Methods from Deref<Target = ByteRange>

pub fn start(&self) -> Option<usize>

Returns the start of the ByteRange, if there is one.

Example

assert_eq!(ByteRange::from(0..5).start(), Some(0));
assert_eq!(ByteRange::from(..5).start(), None);

pub fn end(&self) -> usize

Returns the end of the ByteRange.

Example

assert_eq!(ByteRange::from(0..5).end(), 5);
assert_eq!(ByteRange::from(..=5).end(), 6);

pub fn set_len(&mut self, new_len: usize)

Changes the length of the ByteRange.

Example

let mut range = ByteRange::from(0..5);
range.set_len(2);

assert_eq!(range, ByteRange::from(0..2));

range.set_len(200);
assert_eq!(range, ByteRange::from(0..200));

Note

The start will not be changed.

pub fn set_start(&mut self, new_start: Option<usize>) -> &mut Self

Sets the start of the ByteRange.

Example

assert_eq!(ByteRange::from(0..5).set_start(Some(5)).start(), Some(5));
assert_eq!(ByteRange::from(..5).set_start(Some(2)).start(), Some(2));

Panics

This function will panic, if the new_start is larger, than the end.

pub fn len(&self) -> usize

Returns the length, which is calculated by subtracting the end from the start. If the start is None a 0 is assumed.

Example

let range = ByteRange::from(1..16);

assert_eq!(range.len(), 15);

pub fn is_empty(&self) -> bool

Returns true if the length is zero.

Example

let range = ByteRange::from(12..12);

assert_eq!(range.is_empty(), true);

Trait Implementations

impl<T> Add<T> for ExtXByteRange where
    ByteRange: Add<T, Output = ByteRange>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T> AddAssign<T> for ExtXByteRange where
    ByteRange: AddAssign<T>, 

fn add_assign(&mut self, other: T)

Performs the += operation.

impl AsMut<ByteRange> for ExtXByteRange

fn as_mut(&mut self) -> &mut ByteRange

Performs the conversion.

impl AsRef<ByteRange> for ExtXByteRange

fn as_ref(&self) -> &ByteRange

Performs the conversion.

impl Clone for ExtXByteRange

fn clone(&self) -> ExtXByteRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExtXByteRange

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

Formats the value using the given formatter.

impl Deref for ExtXByteRange

type Target = ByteRange

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ExtXByteRange

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for ExtXByteRange

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

Formats the value using the given formatter.

impl<__FromT0> From<__FromT0> for ExtXByteRange where
    ByteRange: From<__FromT0>, 

fn from(original: __FromT0) -> ExtXByteRange

Performs the conversion.

impl Hash for ExtXByteRange

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Into<ByteRange> for ExtXByteRange

fn into(self) -> ByteRange

Performs the conversion.

impl Ord for ExtXByteRange

fn cmp(&self, other: &ExtXByteRange) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ExtXByteRange> for ExtXByteRange

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

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

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

This method tests for !=.

impl PartialOrd<ExtXByteRange> for ExtXByteRange

fn partial_cmp(&self, other: &ExtXByteRange) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Sub<T> for ExtXByteRange where
    ByteRange: Sub<T, Output = ByteRange>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T> SubAssign<T> for ExtXByteRange where
    ByteRange: SubAssign<T>, 

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl TryFrom<&'_ str> for ExtXByteRange

type Error = Error

The type returned in the event of a conversion error.

fn try_from(input: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ExtXByteRange

impl Eq for ExtXByteRange

impl StructuralEq for ExtXByteRange

impl StructuralPartialEq for ExtXByteRange