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
impl SectionMap
Sourcepub fn from_commits(commits: Vec<Commit>) -> SectionMap
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§
impl Freeze for SectionMap
impl RefUnwindSafe for SectionMap
impl Send for SectionMap
impl Sync for SectionMap
impl Unpin for SectionMap
impl UnwindSafe for SectionMap
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more