Struct RangeRequest 

#[non_exhaustive]
pub struct RangeRequest {
    pub store_id: String,
    pub retrieval_key: Option<String>,
    pub root: Option<String>,
    pub capsule: bool,
    pub offset: u64,
    pub length: u64,
    pub skip_layout: Option<bool>,
}

A byte-range request (dig.fetchRange, L7 spec §9) written at the start of a range-scoped stream. Identifies a resource (store_id + retrieval_key [+ root]) or a whole capsule (capsule: true, identified by store_id [+ root]) and the [offset, offset+length) range.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

store_id: String

The store id (64-hex).

retrieval_key: Option<String>

The resource retrieval key (64-hex). Omitted when capsule is true.

root: Option<String>

The generation root (64-hex). Optional — defaults to the chain-anchored tip.

capsule: bool

Fetch a whole capsule / .dig (identified by store_id [+ root]) rather than one resource.

offset: u64

Start offset (bytes) into the resource ciphertext. Default 0.

length: u64

Length (bytes) to return (widened to whole-chunk boundaries; clamped to the node window).

skip_layout: Option<bool>

Suppress the resource-scaling layout metadata (chunk_lens + inclusion_proof) on this stream’s frames, because the client already holds the commitment for this root.

A client that has already read the layout once — a resumed download, a second range of the same resource, a parallel fetch from another holder — does not need it again, and for a large resource re-sending it costs a paged prologue per stream. Absent or false preserves the pre-0.13.0 behaviour, so an older holder that ignores this field is never broken by it: it simply sends metadata the client discards. The fixed-size identity fields (root, total_length, chunk_count, chunk_index) are NOT suppressed — they are what detects a wrong-generation holder on arrival.

Implementations

impl RangeRequest

pub fn resource( store_id: impl Into<String>, retrieval_key: impl Into<String>, offset: u64, length: u64, ) -> Self

A range request for a content resource (store_id + retrieval_key).

pub fn capsule(store_id: impl Into<String>, offset: u64, length: u64) -> Self

A range request for a whole capsule / .dig, identified by store_id (plus a root if the caller pins a generation).

pub fn with_root(self, root: impl Into<String>) -> Self

Pin the request to one generation root (64-hex) rather than the chain-anchored tip.

pub fn with_skip_layout(self, skip_layout: bool) -> Self

Ask the holder to omit the resource-scaling layout metadata, because this client already holds the commitment for this root. See RangeRequest::skip_layout.

pub fn encode(&self) -> Result<Vec<u8>>

Serialize as a u32 big-endian length prefix + JSON body — the preamble a peer reads to learn the resource + range before streaming the frames.

pub async fn decode<R: AsyncRead + Unpin>(r: &mut R) -> Result<Self>

Read + decode a RangeRequest preamble from r (the serving side of a range stream).

Trait Implementations

impl Clone for RangeRequest

fn clone(&self) -> RangeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RangeRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RangeRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RangeRequest

impl PartialEq for RangeRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RangeRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RangeRequest