Struct Lints

pub struct Lints { /* private fields */ }

A collection of lints

Implementations

impl Lints

pub const fn new(lints: BTreeSet<Lint>) -> Self

Create a new lint

Examples

use std::collections::BTreeSet;

use mit_lint::Lints;
Lints::new(BTreeSet::new());

pub fn available() -> &'static Self

Get the available lints

Examples

use mit_lint::{Lint, Lints};

let lints = Lints::available().clone();
assert!(lints.into_iter().count() > 0);

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

Get all the names of these lints

Examples

use mit_lint::{Lint, Lints};

let names = Lints::available().clone().names();
assert!(names.contains(&Lint::SubjectNotSeparateFromBody.name()));

pub fn config_keys(self) -> Vec<String>

Get all the config keys of these lints

Examples

use mit_lint::{Lint, Lints};

let names = Lints::available().clone().config_keys();
assert!(names.contains(&Lint::SubjectNotSeparateFromBody.config_key()));

pub fn merge(&self, other: &Self) -> Self

Create the union of two lints

Examples

use mit_lint::{Lint, Lints};

let to_add = Lints::new(vec![Lint::NotEmojiLog].into_iter().collect());
let actual = Lints::available().clone().merge(&to_add).names();
assert!(actual.contains(&Lint::NotEmojiLog.name()));

pub fn subtract(&self, other: &Self) -> Self

Get the lints that are in self, but not in other

Examples

use mit_lint::{Lint, Lints};

let to_remove = Lints::new(vec![Lint::SubjectNotSeparateFromBody].into_iter().collect());
let actual = Lints::available().clone().subtract(&to_remove).names();
assert!(!actual.contains(&Lint::SubjectNotSeparateFromBody.name()));

Trait Implementations

impl Clone for Lints

fn clone(&self) -> Lints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lints

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

Formats the value using the given formatter.

impl From<Lints> for Vec<Lint>

fn from(lints: Lints) -> Self

Converts to this type from the input type.

impl From<Vec<Lint>> for Lints

fn from(lints: Vec<Lint>) -> Self

Converts to this type from the input type.

impl IntoIterator for Lints

type Item = Lint

The type of the elements being iterated over.

type IntoIter = IntoIter<Lint>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Lints

fn eq(&self, other: &Lints) -> 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 TryFrom<Lints> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(lints: Lints) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<&str>> for Lints

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<&str>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Lints

impl StructuralPartialEq for Lints