Struct iroh_bytes::protocol::RangeSpec

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

A chunk range specification.

this is a sequence of spans, where the first span is considered false, and each subsequent span is alternating.

Examples: The range 10..33 would be encoded as [10, 23] The empty range would be encoded as the empty array [] A full interval .. would be encoded as [0] A half open interval 15.. would be encoded as [15]

All values except for the first one must be non-zero. The first value may be zero. Values are bao chunk numbers, not byte offsets.

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<RangeSetRef<ChunkNum>>) -> Self

Create a new range spec from a range set

pub const EMPTY: Self = _

An empty range spec

pub fn all() -> Self

Create a range spec that covers the entire range

pub fn is_empty(&self) -> bool

Check if this range spec is empty

pub fn is_all(&self) -> bool

Check if this range spec covers all values

pub fn to_chunk_ranges(&self) -> RangeSet2<ChunkNum>

Convert a range set from this range spec

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 PartialEq<RangeSpec> 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 StructuralEq for RangeSpec

impl StructuralPartialEq for RangeSpec