Struct Problem

pub struct Problem { /* private fields */ }

Information about the breaking of the lint

Implementations

impl Problem

pub fn new( error: String, tip: String, code: Code, commit_message: &CommitMessage<'_>, labels: Option<Vec<(String, usize, usize)>>, url: Option<String>, ) -> Self

Create a new problem

Examples

use std::option::Option::None;

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

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

pub const fn code(&self) -> &Code

Get the code for this problem

Examples

use std::option::Option::None;

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

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

pub fn commit_message(&self) -> CommitMessage<'_>

Get the commit message for this problem

Examples

use std::option::Option::None;

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

assert_eq!(
    problem.commit_message(),
    CommitMessage::from("Commit Message")
)

pub fn error(&self) -> &str

Get the descriptive title for this error

Examples

use std::option::Option::None;

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

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 std::option::Option::None;

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

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 Diagnostic for Problem

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or Enums will work just fine.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for Problem

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

Formats the value using the given formatter.

impl Error for Problem

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for Problem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Problem

impl StructuralPartialEq for Problem