Struct CommentWriter

pub(crate) struct CommentWriter {
    enabled: bool,
    global_comments: Vec<String>,
    entity_comments: HashMap<AnyEntity, String>,
}

Fields

enabled: bool

global_comments: Vec<String>

entity_comments: HashMap<AnyEntity, String>

Implementations

impl CommentWriter

pub(crate) fn new() -> Self

pub(crate) fn enabled(&self) -> bool

pub(crate) fn clear(&mut self)

pub(crate) fn add_global_comment<S: Into<String>>(&mut self, comment: S)

pub(crate) fn add_comment<S: Into<String> + AsRef<str>, E: Into<AnyEntity>>( &mut self, entity: E, comment: S, )

Trait Implementations

impl Clone for CommentWriter

fn clone(&self) -> CommentWriter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentWriter

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

Formats the value using the given formatter.

impl Default for CommentWriter

fn default() -> Self

Returns the “default value” for a type.

impl FuncWriter for &CommentWriter

fn write_preamble( &mut self, w: &mut dyn Write, func: &Function, ) -> Result<bool, Error>

Write the preamble to w. By default, this uses write_entity_definition.

fn write_entity_definition( &mut self, w: &mut dyn Write, _func: &Function, entity: AnyEntity, value: &dyn Display, maybe_fact: Option<&Fact>, ) -> Result

Write an entity definition defined in the preamble to w.

fn write_block_header( &mut self, w: &mut dyn Write, func: &Function, block: Block, indent: usize, ) -> Result

Write the basic block header for the current function.

fn write_instruction( &mut self, w: &mut dyn Write, func: &Function, aliases: &SecondaryMap<Value, Vec<Value>>, inst: Inst, indent: usize, ) -> Result

Write the given inst to w.

fn super_preamble( &mut self, w: &mut dyn Write, func: &Function, ) -> Result<bool, Error>

Default impl of write_preamble

fn super_entity_definition( &mut self, w: &mut dyn Write, func: &Function, entity: AnyEntity, value: &dyn Display, maybe_fact: Option<&Fact>, ) -> Result<(), Error>

Default impl of write_entity_definition

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: 80 bytes