Struct Finding 

pub struct Finding {
    pub severity: Severity,
    pub title: String,
    pub detail: String,
    pub file: String,
    pub in_scope: bool,
    pub problem: Option<String>,
    pub reproduction: Option<String>,
    pub impact: Option<String>,
    pub expected: Option<String>,
}

Fields

severity: Severity

title: String

detail: String

file: String

in_scope: bool

A real problem that this PR did not cause. Those become follow-ups rather than review comments, so they cannot gate an unrelated merge.

problem: Option<String>

What is wrong, with the specifics.

reproduction: Option<String>

Steps to reproduce it, and what actually happens.

impact: Option<String>

What it costs somebody.

expected: Option<String>

What it should do instead.

Implementations

impl Finding

pub fn report_sections(&self) -> Vec<(&'static str, &str)>

The parts of a bug report this finding carries, in the order they are written, skipping the ones it does not.

impl Finding

pub fn blocks(&self) -> bool

pub fn where_at(&self) -> &str

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Finding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finding

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

Formats the value using the given formatter.

impl Default for Finding

fn default() -> Self

A blank finding, for building one field at a time.

Severity is spelled out here rather than derived, because a severity arriving by default is exactly the mistake this codebase refuses elsewhere: it is the field that decides whether a merge is gated, and the least severe value is the only safe thing to assume.

impl<'de> Deserialize<'de> for Finding

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Finding

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

where __S: Serializer,

Serialize this value into the given Serde serializer.