Struct DirectoryRef 

pub struct DirectoryRef {
    pub key: String,
    pub length: u64,
    pub directory_version: u8,
    pub encoding: Option<String>,
    pub layout: Option<String>,
    pub root_length: Option<u64>,
    pub page_count: Option<u64>,
    pub page_entries: Option<u64>,
}

Pointer to the encoded directory object.

Fields

key: String

Object key, relative to the dataset root (e.g. index/<hash>.sttd).

length: u64

Directory object length in bytes (the at-rest object, i.e. the compressed length when encoding is set).

directory_version: u8

Directory codec version (5 for the packed format). The leaf pages of a paged directory are this same v5 codec — layout (below), not this version, discriminates the container shape.

encoding: Option<String>

At-rest encoding of the directory object. Some("zstd") means the object bytes are a zstd frame wrapping the codec bytes; absent (the shape every pre-encoding manifest has) means raw codec bytes. For a paged directory it describes the framing of each page (root + every leaf), not one frame over the whole object. The content address and length always describe the at-rest bytes.

layout: Option<String>

Container layout. Some("paged") = a root page + leaf pages (Wave 2); absent or Some("single") = the single whole-load object. Readers that don’t know "paged" fail loudly (the root’s first byte isn’t a valid v5 directory version), which is why readers ship before any paged dataset.

root_length: Option<u64>

At-rest byte length of the root page (a prefix of the object). Present iff layout == "paged"; the reader range-GETs bytes=0-(rootLength-1) for the root under formatVersion 1, or bytes=0-(8+rootLength-1) under formatVersion 2 (the 8-byte object magic shifts the root), then leaf ranges on demand.

page_count: Option<u64>

Number of leaf pages (informational / validation). Paged only.

page_entries: Option<u64>

Nominal entries-per-page used at build (informational). Paged only.

Implementations

impl DirectoryRef

pub fn is_paged(&self) -> bool

Is this a paged-container directory?

Trait Implementations

impl Clone for DirectoryRef

fn clone(&self) -> DirectoryRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectoryRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectoryRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DirectoryRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.