Struct AuditRun 

pub struct AuditRun { /* private fields */ }

Configuration for an audit run.

Implementations

impl AuditRun

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Begin a new audit run for the given crate name and version.

Examples found in repository

examples/basic.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let run = AuditRun::new("example", "0.1.0").scope(AuditScope::All);
    let result = run.execute()?;
    let report = result.into_report();
    println!("{}", report.to_json()?);
    Ok(())
}

pub fn scope(self, scope: AuditScope) -> Self

Set the audit scope.

Examples found in repository

examples/basic.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let run = AuditRun::new("example", "0.1.0").scope(AuditScope::All);
    let result = run.execute()?;
    let report = result.into_report();
    println!("{}", report.to_json()?);
    Ok(())
}

pub fn audit_scope(&self) -> AuditScope

Selected scope.

pub fn execute(&self) -> Result<AuditResult, AuditError>

Execute the audit run.

In 0.9.0 this is a stub; full cargo-audit and cargo-deny integration lands in 0.9.1.

Examples found in repository

examples/basic.rs (line 9)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let run = AuditRun::new("example", "0.1.0").scope(AuditScope::All);
    let result = run.execute()?;
    let report = result.into_report();
    println!("{}", report.to_json()?);
    Ok(())
}

Trait Implementations

impl Clone for AuditRun

fn clone(&self) -> AuditRun

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditRun

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

Formats the value using the given formatter.