Struct iroh_bytes::protocol::RangeSpecSeq

#[repr(transparent)]
pub struct RangeSpecSeq(_);

A compressed sequence of range specs

Examples:

All child ranges: [(0, [0])] starting at offset 0, all offsets (see above) First chunk of all children: [(0, [0, 1])] starting at offset 0, chunk range 0..1 All of child 1234: [(1234, [0]), [1, []]]. First 33 chunks of child 5678: [(5678, [0, 33]), (1, [])]. Chunks 10 to 30 of child 6789: [(6789, [10, 20]), (1, [])]. No child ranges: []

This is a smallvec so that we can avoid allocations in the common case of a single child range.

Implementations

impl RangeSpecSeq

pub const fn empty() -> Self

An empty range spec sequence

When iterated, will return an empty range forever

pub fn single(&self) -> Option<(u64, &RangeSpec)>

If this range seq describes a range for a single item, returns the offset and range spec for that item

pub fn all() -> Self

A complete range spec sequence

When iterated, will return a full range forever

pub fn new(children: impl IntoIterator<Item = RangeSet2<ChunkNum>>) -> Self

Create a new range spec sequence from a sequence of range sets

pub fn iter(&self) -> RequestRangeSpecIter<'_>

An infinite iterator of range specs

pub fn iter_non_empty(&self) -> NonEmptyRequestRangeSpecIter<'_>

An iterator over non empty range specs

This iterator is infinite if the range spec is infinite

Trait Implementations

impl Clone for RangeSpecSeq

fn clone(&self) -> RangeSpecSeq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeSpecSeq

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RangeSpecSeq

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<RangeSpecSeq> for RangeSpecSeq

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

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 RangeSpecSeq

impl StructuralEq for RangeSpecSeq

impl StructuralPartialEq for RangeSpecSeq