Struct miri::borrow_tracker::tree_borrows::diagnostics::NodeDebugInfo

pub struct NodeDebugInfo {
    pub tag: BorTag,
    pub name: Option<String>,
    pub history: History,
}

Some information that is irrelevant for the algorithm but very convenient to know about a tag for debugging and testing.

Fields

tag: BorTag

The tag in question.

name: Option<String>

Name(s) that were associated with this tag (comma-separated). Typically the name of the variable holding the corresponding pointer in the source code. Helps match tag numbers to human-readable names.

history: History

Notable events in the history of this tag, used for diagnostics.

NOTE: by virtue of being part of NodeDebugInfo, the history is automatically cleaned up by the GC. NOTE: this is !Send, it needs to be converted before displaying the actual diagnostics because src/diagnostics.rs requires Send.

Implementations

impl NodeDebugInfo

pub fn new(tag: BorTag, initial: Permission, span: Span) -> Self

Information for a new node. By default it has no name and an empty history.

pub fn add_name(&mut self, name: &str)

Add a name to the tag. If a same tag is associated to several pointers, it can have several names which will be separated by commas.

Trait Implementations

impl Clone for NodeDebugInfo

fn clone(&self) -> NodeDebugInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeDebugInfo

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

Formats the value using the given formatter.

impl Display for NodeDebugInfo

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

Formats the value using the given formatter.

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