Struct rustsec::database::Query

pub struct Query { /* private fields */ }

Queries against the RustSec database

Implementations

impl Query

pub fn new() -> Self

Create a new query.

This creates a “wildcard” query with no constraints. Use the various builder methods of this type to restrict which advisories match.

Note that this differs from Query::default(), which scopes the query to crates (i.e. Query::crate_scope).

When in doubt, use Query::default().

pub fn crate_scope() -> Self

Create a new query which uses the default scope rules for crates:

• Only Collection::Crates
• Ignore withdrawn advisories
• Ignore informational advisories

pub fn collection(self, collection: Collection) -> Self

Set collection to query against

pub fn package(self, package: &Package) -> Self

Provide a package and use all of its attributes as part of the query

pub fn package_name(self, name: Name) -> Self

Set package name to search for.

pub fn package_version(self, version: Version) -> Self

Set package version to search for

pub fn package_source(self, source: SourceId) -> Self

Set package source (e.g. registry) where this package is located

pub fn severity(self, severity: Severity) -> Self

Set minimum severity threshold according to the CVSS Qualitative Severity Rating Scale.

Vulnerabilities without associated CVSS information will always match regardless of what this is set to.

pub fn target_arch(self, arch: Arch) -> Self

Set target architecture

pub fn target_os(self, os: OS) -> Self

Set target operating system

pub fn year(self, year: u32) -> Self

Query for vulnerabilities occurring in a specific year.

pub fn withdrawn(self, setting: bool) -> Self

Query for withdrawn advisories.

By default they will be omitted from query results.

pub fn informational(self, setting: bool) -> Self

Query for informational advisories. By default they will be omitted from query results.

pub fn matches(&self, advisory: &Advisory) -> bool

Does this query match a given advisory?

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Query

Returns the “default value” for a type.