Struct unclog::Changelog [−][src]
pub struct Changelog { pub unreleased: Option<ChangeSet>, pub releases: Vec<Release>, pub epilogue: Option<String>, }
Expand description
A log of changes for a specific project.
Fields
unreleased: Option<ChangeSet>
Unreleased changes don’t have version information associated with them.
releases: Vec<Release>
An ordered list of releases’ changes.
epilogue: Option<String>
Any additional content that must appear at the end of the changelog
(e.g. historical changelog content prior to switching to unclog
).
Implementations
impl Changelog
[src]
impl Changelog
[src]pub fn init_dir<P: AsRef<Path>, E: AsRef<Path>>(
path: P,
epilogue_path: Option<E>
) -> Result<()>
[src]
pub fn init_dir<P: AsRef<Path>, E: AsRef<Path>>(
path: P,
epilogue_path: Option<E>
) -> Result<()>
[src]Initialize a new (empty) changelog in the given path.
Creates the target folder if it doesn’t exist, and optionally copies an epilogue into it.
pub fn read_from_dir<P: AsRef<Path>>(path: P) -> Result<Self>
[src]
pub fn read_from_dir<P: AsRef<Path>>(path: P) -> Result<Self>
[src]Attempt to read a full changelog from the given directory.
pub fn add_unreleased_entry<P, S, I, C>(
path: P,
section: S,
id: I,
content: C
) -> Result<()> where
P: AsRef<Path>,
S: AsRef<str>,
I: AsRef<str>,
C: AsRef<str>,
[src]
pub fn add_unreleased_entry<P, S, I, C>(
path: P,
section: S,
id: I,
content: C
) -> Result<()> where
P: AsRef<Path>,
S: AsRef<str>,
I: AsRef<str>,
C: AsRef<str>,
[src]Adds a changelog entry with the given ID to the specified section in
the unreleased
folder.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Changelog
impl Send for Changelog
impl Sync for Changelog
impl Unpin for Changelog
impl UnwindSafe for Changelog
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more