[−][src]Trait noter::NoteWriter

pub trait NoteWriter {
    fn title(&mut self, title: &str);

    fn variant_header(&mut self, variant: &NoteVariant);

    fn release_note(
        &mut self, 
        variant: &NoteVariant, 
        ticket: &str, 
        description: &str, 
        issue: &str
    );

    fn variant_footer(&mut self);

    fn spacing(&mut self, lines: usize);

    fn write(&mut self) -> String;

    fn _title<T: AsRef<str>>(&mut self, title: T) { ... }

    fn _release_note<S: AsRef<str>, T: AsRef<str>, U: AsRef<str>>(
        &mut self, 
        variant: &NoteVariant, 
        ticket: S, 
        description: T, 
        issue: U
    ) { ... }
}

The NoteWriter trait is used to generate release notes from compiled release note files.

Required methods

fn title(&mut self, title: &str)

Write out a title line.

fn variant_header(&mut self, variant: &NoteVariant)

Start an itemized list of release notes for a given variant.

fn release_note(
    &mut self,
    variant: &NoteVariant,
    ticket: &str,
    description: &str,
    issue: &str
)

Write a single release note

End the most recently started variant list.

fn spacing(&mut self, lines: usize)

Write out lines many empty lines.

fn write(&mut self) -> String

Consumes the writer, returning the notes as a String.

Loading content...

Provided methods

fn _title<T: AsRef<str>>(&mut self, title: T)

Write out a title line.

fn _release_note<S: AsRef<str>, T: AsRef<str>, U: AsRef<str>>(
    &mut self,
    variant: &NoteVariant,
    ticket: S,
    description: T,
    issue: U
)

Write a single release note

Loading content...

Implementors

impl NoteWriter for StringWriter[src]

Loading content...