Struct rustsec::database::Database

pub struct Database { /* fields omitted */ }

Database of RustSec security advisories, indexed both by ID and collection

Implementations

impl Database

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

Open Database located at the given local path

pub fn load_from_repo(repo: &Repository) -> Result<Self, Error>

Load Database from the given git::Repository

pub fn fetch() -> Result<Self, Error>

Fetch the default advisory database from GitHub

pub fn get(&self, id: &Id) -> Option<&Advisory>

Look up an advisory by an advisory ID (e.g. “RUSTSEC-YYYY-XXXX”)

pub fn query(&self, query: &Query) -> Vec<&Advisory>

Query the database according to the given query object

pub fn query_vulnerabilities(
    &self,
    lockfile: &Lockfile,
    query: &Query,
    package_scope: impl Into<Package>
) -> Vec<Vulnerability>

Find vulnerabilities in the provided Lockfile which match a given query.

pub fn vulnerabilities(&self, lockfile: &Lockfile) -> Vec<Vulnerability>

Scan for vulnerabilities in the provided Lockfile.

pub fn iter(&self) -> Iter<'_>

Iterate over all of the advisories in the database

pub fn latest_commit(&self) -> Option<&Commit>

Get information about the latest commit to the repo

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.

impl IntoIterator for Database

type Item = Advisory

The type of the elements being iterated over.

type IntoIter = IntoIter<Advisory>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.