Struct noter::StringWriter

pub struct StringWriter { /* fields omitted */ }

Methods

impl StringWriter

pub fn new(formatter: NoteFormatter) -> Self

pub fn text() -> Self

pub fn markdown() -> Self

Trait Implementations

impl Clone for StringWriter

fn clone(&self) -> StringWriter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringWriter

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

Formats the value using the given formatter.

impl NoteWriter for StringWriter

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

fn variant_footer(&mut self)

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.

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

impl PartialEq<StringWriter> for StringWriter

fn eq(&self, other: &StringWriter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StringWriter) -> bool

This method tests for !=.

impl StructuralPartialEq for StringWriter