Struct BufWriter

pub struct BufWriter {
    buf: String,
}

The buffered writer. Writes various display items into the internal buffer.

Fields

buf: String

Implementations

impl BufWriter

pub fn new(content: impl ToString) -> Self

Create new instance of BufWriter from ToString.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

pub fn write_doc<T: AsDoc>(&mut self, doc: &T) -> Result

Write AsDoc implementation to the buffer.

pub fn writeln_doc<T: AsDoc>(&mut self, doc: &T) -> Result

Write AsDoc implementation to the buffer with newline.

pub fn write_raw<T: Display>(&mut self, content: T) -> Result

Writes raw content to the buffer.

pub fn writeln_raw<T: Display>(&mut self, content: T) -> Result

Writes raw content to the buffer with newline.

pub fn writeln(&mut self) -> Result

Writes newline to the buffer.

pub fn write_title(&mut self, title: &str) -> Result

Writes a title to the buffer formatted as Markdown::H1.

pub fn write_subtitle(&mut self, subtitle: &str) -> Result

Writes a subtitle to the bugger formatted as Markdown::H2.

pub fn write_heading(&mut self, heading: &str) -> Result

Writes heading to the buffer formatted as Markdown::H3.

pub fn write_italic(&mut self, text: &str) -> Result

Writes text in italics to the buffer formatted as Markdown::Italic.

pub fn write_bold(&mut self, text: &str) -> Result

Writes bold text to the buffer formatted as Markdown::Bold.

pub fn write_link(&mut self, name: &str, path: &str) -> Result

Writes link to the buffer formatted as Markdown::Link.

pub fn write_list_item(&mut self, item: &str, depth: usize) -> Result

Writes a list item to the buffer indented by specified depth.

pub fn write_link_list_item( &mut self, name: &str, path: &str, depth: usize, ) -> Result

Writes a link to the buffer as a list item.

pub fn write_code(&mut self, code: &str) -> Result

Writes a solidity code block block to the buffer.

pub fn write_section(&mut self, comments: &Comments, code: &str) -> Result

Write an item section to the buffer. First write comments, the item itself as code.

fn try_write_table<T>( &mut self, tag: CommentTag, params: &[T], comments: &Comments, heading: &str, ) -> Result

where T: ParamLike,

Tries to write the table to the buffer. Doesn’t write anything if either params or comments are empty.

pub fn try_write_properties_table( &mut self, params: &[VariableDeclaration], comments: &Comments, ) -> Result

Tries to write the properties table to the buffer. Doesn’t write anything if either params or comments are empty.

pub fn try_write_events_table( &mut self, params: &[EventParameter], comments: &Comments, ) -> Result

Tries to write the parameters table to the buffer. Doesn’t write anything if either params or comments are empty.

pub fn try_write_errors_table( &mut self, params: &[ErrorParameter], comments: &Comments, ) -> Result

Tries to write the parameters table to the buffer. Doesn’t write anything if either params or comments are empty.

pub fn try_write_param_table( &mut self, tag: CommentTag, params: &[&Parameter], comments: &Comments, ) -> Result

Tries to write the parameters table to the buffer. Doesn’t write anything if either params or comments are empty.

pub fn write_deployments_table( &mut self, deployments: Vec<Deployment>, ) -> Result

Writes the deployment table to the buffer.

pub fn write_piped(&mut self, content: &str) -> Result

Write content to the buffer surrounded by pipes.

pub fn finish(self) -> String

Finish and return underlying buffer.

Trait Implementations

impl Debug for BufWriter

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

Formats the value using the given formatter.

impl Default for BufWriter

fn default() -> BufWriter

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes