Skip to main content

ScanReport

Struct ScanReport 

Source
pub struct ScanReport { /* private fields */ }
Expand description

Findings produced by scanning one UTF-8 source.

Findings are stored in deterministic source order. A report owns its findings and cannot be mutated after construction.

Implementations§

Source§

impl ScanReport

Source

pub fn findings(&self) -> &[Finding]

Returns all findings in deterministic order.

Source

pub fn len(&self) -> usize

Returns the number of findings in this report.

Source

pub fn candidates(&self) -> &[SensitiveCandidate]

Returns ambiguous sensitive candidates in deterministic source order.

Candidates are review-only structural observations. They are not findings and do not carry severity, finding confidence or remediation.

Source

pub fn candidate_len(&self) -> usize

Returns the number of ambiguous sensitive candidates in this report.

Source

pub fn has_candidates(&self) -> bool

Returns true when this report contains at least one ambiguous sensitive candidate.

Source

pub fn needs_review(&self) -> bool

Returns true when either a finding or an ambiguous sensitive candidate requires review.

Source

pub fn is_empty(&self) -> bool

Returns true when this report contains no findings.

Ambiguous sensitive candidates are intentionally not findings and therefore do not affect this compatibility helper. Use ScanReport::needs_review when candidates must also be considered.

Source

pub fn has_critical(&self) -> bool

Returns true when at least one finding is critical.

Iteration stops as soon as the first critical finding is encountered.

Source

pub fn by_severity( &self, severity: Severity, ) -> impl DoubleEndedIterator<Item = &Finding> + '_

Iterates over findings with exactly the requested severity.

This method performs no allocation and does not clone findings.

Returns an iterator that yields references to Findings with the given severity.

Source

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

Iterates over all findings in deterministic order.

Source

pub fn into_findings(self) -> Box<[Finding]>

Consumes the report and returns its owned findings.

Source

pub fn into_candidates(self) -> Box<[SensitiveCandidate]>

Consumes the report and returns its ambiguous sensitive candidates.

Trait Implementations§

Source§

impl Clone for ScanReport

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScanReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ScanReport

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for ScanReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ScanReport

Source§

impl<'a> IntoIterator for &'a ScanReport

Source§

type Item = &'a Finding

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, Finding>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for ScanReport

Source§

type Item = Finding

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<Finding>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for ScanReport

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScanReport

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.