Struct Summary 

pub struct Summary { /* private fields */ }

Implementations

impl Summary

pub fn new() -> Self

pub fn write(&mut self) -> Result<&mut Self, Box<dyn Error>>

pub fn write_with_options( &mut self, options: &SummaryWriteOptions, ) -> Result<&mut Self, Box<dyn Error>>

pub fn clear(&mut self) -> Result<&mut Self, Box<dyn Error>>

pub fn stringify(&self) -> String

pub fn is_empty_buffer(&self) -> bool

pub fn empty_buffer(&mut self) -> &mut Self

pub fn add_raw(&mut self, text: impl AsRef<str>) -> &mut Self

pub fn add_raw_with_add_eol( &mut self, text: impl AsRef<str>, add_eol: bool, ) -> &mut Self

pub fn add_eol(&mut self) -> &mut Self

pub fn add_code_block(&mut self, code: impl AsRef<str>) -> &mut Self

pub fn add_code_block_with_lang( &mut self, code: impl AsRef<str>, lang: impl AsRef<str>, ) -> &mut Self

pub fn add_list(&mut self, items: &[impl AsRef<str>]) -> &mut Self

pub fn add_list_with_ordered( &mut self, items: &[impl AsRef<str>], ordered: bool, ) -> &mut Self

pub fn add_table<'a>( &mut self, rows: impl AsRef<[SummaryTableRow<'a>]>, ) -> &mut Self

pub fn add_details( &mut self, label: impl AsRef<str>, content: impl AsRef<str>, ) -> &mut Self

pub fn add_image( &mut self, src: impl AsRef<str>, alt: impl AsRef<str>, ) -> &mut Self

pub fn add_image_with_options( &mut self, src: impl AsRef<str>, alt: impl AsRef<str>, options: &SummaryImageOptions<'_>, ) -> &mut Self

pub fn add_heading(&mut self, text: impl AsRef<str>) -> &mut Self

pub fn add_heading_with_level( &mut self, text: impl AsRef<str>, level: u8, ) -> &mut Self

pub fn add_separator(&mut self) -> &mut Self

pub fn add_break(&mut self) -> &mut Self

pub fn add_quote(&mut self, text: impl AsRef<str>) -> &mut Self

pub fn add_quote_with_cite( &mut self, text: impl AsRef<str>, cite: impl AsRef<str>, ) -> &mut Self

pub fn add_link( &mut self, text: impl AsRef<str>, href: impl AsRef<str>, ) -> &mut Self

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl Default for Summary

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Summary

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Summary

impl StructuralPartialEq for Summary