Struct mit_commit_message_lints::mit::Authors[−][src]

pub struct Authors<'a> {
    pub authors: BTreeMap<String, Author<'a>>,
}

Expand description

Collection of authors

Fields

authors: BTreeMap<String, Author<'a>>

A btree of the authors

Implementations

[src]

impl<'a> Authors<'a>

[src]

pub fn missing_initials(
 &'a self,
 authors_initials: Vec<&'a str>
) -> Vec<&'a str>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

From a list of initials get te ones that aren’t in our config

[src]

pub fn new(authors: BTreeMap<String, Author<'a>>) -> Self

Create a new author collection

[src]

pub fn get(&self, author_initials: &'a [&'a str ]) -> Vec<&'a Author<'_>>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get some authors by their initials

[src]

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

Merge two lists of authors

This is used if the user has a author config file, and the authors are also saved in the vcs config

[src]

pub fn example() -> Self

Generate an example authors list

Used to show the user what their config file might look like

Trait Implementations

[src]

impl<'a> Clone for Authors<'a>

[src]

fn clone(&self) -> Authors<'a>

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl<'a> Debug for Authors<'a>

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<'a> Default for Authors<'a>

[src]

fn default() -> Authors<'a>

Returns the “default value” for a type. Read more

[src]

impl<'a> IntoIterator for Authors<'a>

type IntoIter = IntoIter<String, Author<'a>>

Which kind of iterator are we turning this into?

type Item = (String, Author<'a>)

The type of the elements being iterated over.

[src]

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

[src]

impl<'a> PartialEq<Authors<'a>> for Authors<'a>

[src]

fn eq(&self, other: &Authors<'a>) -> bool

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

[src]

fn ne(&self, other: &Authors<'a>) -> bool

This method tests for !=.

[src]

impl TryFrom<&'_ Git2> for Authors<'_>

type Error = Report

The type returned in the event of a conversion error.

[src]

fn try_from(vcs: &Git2) -> Result<Self, Self::Error>

Performs the conversion.

[src]

impl TryFrom<&'_ InMemory<'_>> for Authors<'_>

type Error = Report

The type returned in the event of a conversion error.

[src]

fn try_from(vcs: &InMemory<'_>) -> Result<Self, Self::Error>

Performs the conversion.

[src]

impl<'a> TryFrom<&'a str> for Authors<'a>

type Error = DeserializeAuthorsError

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

impl<'a> TryFrom<Authors<'a>> for String

type Error = SerializeAuthorsError

The type returned in the event of a conversion error.

[src]

fn try_from(value: Authors<'a>) -> Result<Self, Self::Error>

Performs the conversion.

[src]

impl<'a> TryFrom<String> for Authors<'a>

type Error = DeserializeAuthorsError

The type returned in the event of a conversion error.

[src]

fn try_from(input: String) -> Result<Self, Self::Error>

Performs the conversion.

[src]

impl<'a> Eq for Authors<'a>

[src]

impl<'a> StructuralEq for Authors<'a>

[src]

impl<'a> StructuralPartialEq for Authors<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Authors<'a>

impl<'a> Send for Authors<'a>

impl<'a> Sync for Authors<'a>

impl<'a> Unpin for Authors<'a>

impl<'a> UnwindSafe for Authors<'a>

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

[src]

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where
C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where
C: Color,

Set the background color generically. Read more

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

Change the foreground color to white

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn bold(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct mit_commit_message_lints::mit::Authors[−][src]

Fields

Implementations

impl<'a> Authors<'a>

pub fn missing_initials( &'a self, authors_initials: Vec<&'a str>) -> Vec<&'a str>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn new(authors: BTreeMap<String, Author<'a>>) -> Self

pub fn get(&self, author_initials: &'a [&'a str]) -> Vec<&'a Author<'_>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

pub fn example() -> Self

Trait Implementations

impl<'a> Clone for Authors<'a>

fn clone(&self) -> Authors<'a>

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

impl<'a> Debug for Authors<'a>

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

impl<'a> Default for Authors<'a>

fn default() -> Authors<'a>

impl<'a> IntoIterator for Authors<'a>

type IntoIter = IntoIter<String, Author<'a>>

type Item = (String, Author<'a>)

fn into_iter(self) -> Self::IntoIter

impl<'a> PartialEq<Authors<'a>> for Authors<'a>

fn eq(&self, other: &Authors<'a>) -> bool

fn ne(&self, other: &Authors<'a>) -> bool

impl TryFrom<&'_ Git2> for Authors<'_>

type Error = Report

fn try_from(vcs: &Git2) -> Result<Self, Self::Error>

impl TryFrom<&'_ InMemory<'_>> for Authors<'_>

type Error = Report

fn try_from(vcs: &InMemory<'_>) -> Result<Self, Self::Error>

impl<'a> TryFrom<&'a str> for Authors<'a>

type Error = DeserializeAuthorsError

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

impl<'a> TryFrom<Authors<'a>> for String

type Error = SerializeAuthorsError

fn try_from(value: Authors<'a>) -> Result<Self, Self::Error>

impl<'a> TryFrom<String> for Authors<'a>

type Error = DeserializeAuthorsError

fn try_from(input: String) -> Result<Self, Self::Error>

impl<'a> Eq for Authors<'a>

impl<'a> StructuralEq for Authors<'a>

impl<'a> StructuralPartialEq for Authors<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Authors<'a>

impl<'a> Send for Authors<'a>

impl<'a> Sync for Authors<'a>

impl<'a> Unpin for Authors<'a>

impl<'a> UnwindSafe for Authors<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where C: Color,

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

pub fn missing_initials(
&'a self,
authors_initials: Vec<&'a str>
) -> Vec<&'a str>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get(&self, author_initials: &'a [&'a str ]) -> Vec<&'a Author<'_>>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,