Struct SectionMap

Source
pub struct SectionMap {
    pub sections: HashMap<String, BTreeMap<String, Vec<Commit>>>,
}
Expand description

A struct which holds sections to and components->commits map

Fields§

§sections: HashMap<String, BTreeMap<String, Vec<Commit>>>

The top level map of the changelog, i.e. sections -> components

Implementations§

Source§

impl SectionMap

Source

pub fn from_commits(commits: Vec<Commit>) -> SectionMap

Creates a section map from a vector of commits, which we can then iterate through and write

§Example
let clog = Clog::new().unwrap();

// Get the commits we're interested in...
let sm = SectionMap::from_commits(clog.get_commits().unwrap());

// Create a file to hold our results, which the MardownWriter will wrap (note, .unwrap() is only
// used to keep the example short and concise)
let mut file = File::create("my_changelog.md").ok().unwrap();

// Create the MarkdownWriter
let mut writer = MarkdownWriter::new(&mut file);

// Use the MarkdownWriter to write the changelog
clog.write_changelog_with(&mut writer).unwrap();

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.