Struct Authors

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

Collection of authors

Fields

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

A btree of the authors

Implementations

impl<'a> Authors<'a>

pub fn missing_initials( &'a self, authors_initials: Vec<&'a str>, ) -> Vec<&'a str>

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

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

Create a new author collection

pub fn get(&self, author_initials: &'a [&'a str]) -> Vec<&'a Author<'_>>

Get some authors by their initials

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

pub fn example() -> Self

Generate an example authors list

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Authors<'a>

Returns the “default value” for a type.

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.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

fn eq(&self, other: &Authors<'a>) -> 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<&Git2> for Authors<'_>

type Error = Report

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = Report

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = DeserializeAuthorsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = SerializeAuthorsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Authors<'_>

type Error = DeserializeAuthorsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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