Struct BlindIndex 

pub struct BlindIndex { /* private fields */ }

A memory-mapped blind index.

Implementations

impl BlindIndex

pub fn open(path: &Path) -> Result<Self>

Map and check an index file. Cheap whatever the file’s size: see the module documentation for what is and is not checked here.

Errors

ArcsecError::CatalogIo if the file cannot be opened, is not an index, is another version or byte order, or its header is inconsistent.

pub fn validate(&self) -> Result<()>

Recompute every section checksum: a full read of the file.

Errors

ArcsecError::CatalogIo naming the first section whose checksum differs.

pub fn tiers(&self) -> &[TierInfo]

Tiers, widest first.

pub fn n_stars(&self) -> usize

Number of stars.

pub fn n_patterns(&self) -> usize

Number of patterns, all tiers.

pub fn source(&self) -> &str

Database the index was built from.

pub fn source_stamp(&self) -> SourceStamp

Fingerprint of the database the index was built from; not recorded (SourceStamp::is_recorded false) in indexes built before it existed.

pub fn built_unix(&self) -> i64

Build time, seconds since the Unix epoch.

pub fn file_size(&self) -> usize

File size in bytes.

pub fn tier_bytes(&self, t: &TierInfo) -> u64

Bytes of the file belonging to one tier’s patterns (keys and quads).

pub fn lookup(&self, tier: &TierInfo, key: u64) -> Range<usize>

The patterns of tier whose key is exactly key.

pub fn quad(&self, i: usize) -> Option<[IndexStar; 4]>

The four stars of pattern i in canonical order; None if the pattern index or any star index is out of range (a corrupt file).

pub fn star(&self, i: usize) -> Option<IndexStar>

Star i; None if out of range.

pub fn stars_near( &self, ra: f64, dec: f64, radius: f64, f: impl FnMut(&IndexStar), )

Call f for every star within radius (radians) of (ra, dec), and a few just outside it: candidates come from whole directory bands and a RA window widened for the band’s declination, and the caller does the exact test.

Trait Implementations

impl Debug for BlindIndex

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

Formats the value using the given formatter.