Struct mit_lint::Problem

pub struct Problem { /* fields omitted */ }

Information about the breaking of the lint

Implementations

impl Problem

pub fn new(error: String, tip: String, code: Code) -> Problem

Create a new problem

Examples

use mit_lint::{Code, Problem};
let problem = Problem::new(
    "Error title".to_string(),
    "Some advice on how to fix it".to_string(),
    Code::BodyWiderThan72Characters,
);

assert_eq!(problem.error(), "Error title".to_string())

pub fn code(&self) -> &Code

Get the code for this problem

Examples

use mit_lint::{Code, Problem};
let problem = Problem::new(
    "Error title".to_string(),
    "Some advice on how to fix it".to_string(),
    Code::BodyWiderThan72Characters,
);

assert_eq!(problem.code(), &Code::BodyWiderThan72Characters)

pub fn error(&self) -> &str

Get the descriptive title for this error

Examples

use mit_lint::{Code, Problem};
let problem = Problem::new(
    "Error title".to_string(),
    "Some advice on how to fix it".to_string(),
    Code::BodyWiderThan72Characters,
);

assert_eq!(problem.error(), "Error title".to_string())

pub fn tip(&self) -> &str

Get advice on how to fix the problem

This should be a description of why this is a problem, and how to fix it

Examples

use mit_lint::{Code, Problem};
let problem = Problem::new(
    "Error title".to_string(),
    "Some advice on how to fix it".to_string(),
    Code::BodyWiderThan72Characters,
);

assert_eq!(problem.tip(), "Some advice on how to fix it".to_string())

Trait Implementations

impl Clone for Problem

fn clone(&self) -> Problem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Problem

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

Formats the value using the given formatter.

impl PartialEq<Problem> for Problem

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

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

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

This method tests for !=.

impl Eq for Problem

impl StructuralEq for Problem

impl StructuralPartialEq for Problem