Struct OsvDb 

pub struct OsvDb(/* private fields */);

Implementations

impl OsvDb

pub fn new( ecosystems: OsvGsEcosystems, path: impl AsRef<Path>, ) -> Result<Self, OsvDbNewErr>

Creates a new OsvDb rooted at path targeting the given ecosystems.

Pass OsvGsEcosystems::all to cover all ecosystems, or build a specific set with OsvGsEcosystems::add.

If path does not exist it is created (including all parent directories).

Errors

• OsvDbNewErr

pub fn location(&self) -> &Path

Returns the on disk location of the database.

pub fn ecosystems(&self) -> &OsvGsEcosystems

Returns the set of ecosystems this database targets.

An empty set (i.e. OsvGsEcosystems::is_all is true) means all ecosystems.

pub fn last_modified(&self) -> DateTime<Utc>

Returns the latest modified timestamp seen across all records in the database.

The value reflects the most recent download_latest or sync call. Returns the Unix epoch if the database has not yet been populated.

pub fn get_record( &self, id: &OsvRecordId, ) -> Result<Option<OsvRecord>, GetRecordErr>

Looks up a single OSV record by its OsvRecordId.

Returns Ok(None) if no record matching id exists.

Errors

Returns an error if the record file cannot be opened or deserialized.

pub fn records( &self, ) -> Result<impl Iterator<Item = Result<OsvRecord, ReadRecordErr>> + Send, RecordsIterErr>

Returns an Iterator over every OsvRecord stored in the database.

Files are read and parsed synchronously. Each record is yielded as Ok(OsvRecord). I/O or parse failures yield an Err item without terminating the iterator.

pub async fn download_latest( &self, chunk_size: u64, ) -> Result<(), DownloadLatestErr>

Downloads a full, latest OSV database for all configured ecosystems.

• For each targeted ecosystem (or the global archive when all ecosystems are selected), downloads the latest archive into a temporary subdirectory of location and extracts all records into a single flat directory.
• Atomically replaces the current records directory with the newly downloaded one.
• Updates self.last_modified with the maximum modified timestamp seen across all targeted ecosystems.

pub async fn sync( &self, ) -> Result<impl Iterator<Item = Result<OsvRecord, ReadRecordErr>> + Send, SyncErr>

Sync with the latest OSV data, downloads only the records that have been modified since Self::last_modified and updates the local database files accordingly.

Fetches the modified_id.csv index for the configured ecosystem (or all ecosystems if None). The file is sorted in reverse chronological order, so parsing stops as soon as a timestamp at or before Self::last_modified is encountered, avoiding a full re-download. After all new records are saved, Self::last_modified is updated to the highest timestamp seen.

Returns an Iterator that yields each newly added or updated OsvRecord.

Trait Implementations

impl Clone for OsvDb

fn clone(&self) -> OsvDb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OsvDb

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

Formats the value using the given formatter.