Struct Segment 

pub struct Segment {
    pub id: u64,
    pub docs: Vec<DocMeta>,
    pub syms: Vec<SymbolEntry>,
    pub refs: Vec<RefEntry>,
    /* private fields */
}

A read-only, mmap-backed view of a segment.

Fields

id: u64

docs: Vec<DocMeta>

syms: Vec<SymbolEntry>

refs: Vec<RefEntry>

Implementations

impl Segment

pub fn open(paths: &Paths, seg_id: u64) -> Result<Segment>

pub fn doc(&self, doc_id: u32) -> Option<&DocMeta>

pub fn doc_syms(&self, doc_id: u32) -> impl Iterator<Item = &SymbolEntry>

The symbols defined in doc_id, in storage order. O(1) lookup.

pub fn doc_refs(&self, doc_id: u32) -> impl Iterator<Item = &RefEntry>

The references (calls + imports) originating in doc_id. O(1) lookup.

pub fn calls_to(&self, name: &str) -> impl Iterator<Item = &RefEntry>

Call sites whose callee is exactly name, via the prebuilt name index (O(results), no full scan). Liveness is not filtered here; callers that care should check Segment::is_live.

pub fn sym_name_lower(&self, i: usize) -> &str

Lowercased name of the symbol at index i in syms.

pub fn is_live(&self, doc_id: u32) -> bool

pub fn live_count(&self) -> u64

pub fn all_live(&self) -> RoaringBitmap

All live doc ids in this segment.

pub fn candidates(&self, query: &TrigramQuery) -> Result<RoaringBitmap>

Compute candidate doc ids satisfying the trigram query, intersected with the live set. An unconstrained query yields all live docs.