Struct cwe_checker_lib::utils::log::CweWarning

pub struct CweWarning {
    pub name: String,
    pub version: String,
    pub addresses: Vec<String>,
    pub tids: Vec<String>,
    pub symbols: Vec<String>,
    pub other: Vec<Vec<String>>,
    pub description: String,
}

A CWE warning message.

Fields

name: String

A short name of the CWE check, e.g. CWE190.

version: String

The version number of the check.

addresses: Vec<String>

Addresses in the binary associated with the CWE warning. The first address usually denotes the program point where the CWE warning was generated.

tids: Vec<String>

Term IDs associated to the CWE warning. May be more exact than the addresses, e.g. for Def terms.

symbols: Vec<String>

Symbol names (usually of extern symbols) associated to the CWE warning.

other: Vec<Vec<String>>

Other useful information. Content depends on the check that generated the CWE warning.

description: String

A short description of the warning that is presented to the user. Should contain all essential information necessary to understand the warning, including the address in the binary for which the warning was generated.

Implementations

impl CweWarning

pub fn new( name: impl ToString, version: impl ToString, description: impl ToString ) -> CweWarning

Creates a new CweWarning by only setting name, version and description

pub fn addresses(self, addresses: Vec<String>) -> CweWarning

Sets the address field of the CweWarning

pub fn tids(self, tids: Vec<String>) -> CweWarning

Sets the Tids field of the CweWarning

pub fn symbols(self, symbols: Vec<String>) -> CweWarning

Sets the symbols field of the CweWarning

pub fn other(self, other: Vec<Vec<String>>) -> CweWarning

Sets the other field of the CweWarning

Trait Implementations

impl Clone for CweWarning

fn clone(&self) -> CweWarning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CweWarning

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

Formats the value using the given formatter.

impl Default for CweWarning

fn default() -> CweWarning

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CweWarning

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CweWarning

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

Formats the value using the given formatter.

impl From<CweWarning> for LogThreadMsg

fn from(warning: CweWarning) -> Self

Converts to this type from the input type.

impl Hash for CweWarning

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CweWarning

fn cmp(&self, other: &CweWarning) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CweWarning

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CweWarning

fn partial_cmp(&self, other: &CweWarning) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CweWarning

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CweWarning

impl StructuralEq for CweWarning

impl StructuralPartialEq for CweWarning