Struct iroh_blobs::protocol::RangeSpec

pub struct RangeSpec(/* private fields */);

A chunk range specification as a sequence of chunk offsets.

Offsets encode alternating spans starting on 0, where the first span is always deselected.

Examples:

• [2, 5, 3, 1] encodes five spans, of which two are selected:

  • [0, 0+2) = [0, 2) is not selected.
  • [2, 2+5) = [2, 7) is selected.
  • [7, 7+3) = [7, 10) is not selected.
  • [10, 10+1) = [10, 11) is selected.
  • [11, inf) is deselected.

  Such a RangeSpec can be converted to a [ChunkRanges] using containing just the selected ranges: ChunkRanges{2..7, 10..11} using RangeSpec::to_chunk_ranges.

• An empty range selects no spans, encoded as []. This means nothing of the blob is selected.

• To select an entire blob create a single half-open span starting at the first chunk: [0].

• To select the tail of a blob, create a single half-open span: [15].

This is a SmallVec so we can avoid allocations for the very common case of a single chunk range.

Implementations

impl RangeSpec

pub fn new(ranges: impl AsRef<ChunkRangesRef>) -> Self

Creates a new RangeSpec from a range set.

pub const EMPTY: Self = _

A RangeSpec selecting nothing from the blob.

This is called “empty” because the representation is an empty set.

pub fn all() -> Self

Creates a RangeSpec selecting the entire blob.

pub fn is_empty(&self) -> bool

Checks if this RangeSpec does not select any chunks in the blob.

pub fn is_all(&self) -> bool

Checks if this RangeSpec selects all chunks in the blob.

pub fn to_chunk_ranges(&self) -> ChunkRanges

Creates a [ChunkRanges] from this RangeSpec.

Trait Implementations

impl Clone for RangeSpec

fn clone(&self) -> RangeSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RangeSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RangeSpec

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RangeSpec

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

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 RangeSpec

impl StructuralPartialEq for RangeSpec