Struct DataDescription 

pub struct DataDescription {
    pub label_string: Option<String>,
    pub hex_address_string: String,
    pub type_string: String,
    pub value: Option<Value>,
    pub associated_data_descriptions: Option<Vec<DataDescription>>,
}

The data needed to generate a graph node for a data structure

Fields

label_string: Option<String>

The label for this piece of data

Typically this is the variable name or field name.

Leaving this field as None will result in no TD box rendered for this field.

hex_address_string: String

The memory location of this data, as a hex string prefaced with 0x

type_string: String

The fully qualified type of this data

value: Option<Value>

The value of this data

This may be:

1. some owned data, such as a primitive or an enum value, which will be rendered as a string.
2. some referenced data, which will be rendered as an arrow pointing to the referenced data.
3. nothing, as would make sense for a struct, where the real data is the fields, which are represented in DataDescription::associated_data_descriptions

associated_data_descriptions: Option<Vec<DataDescription>>

The DataDescriptions owned by this data

These will be rendered as part of this data.

Implementations

impl DataDescription

pub fn with_label<T>(self, label_string: T) -> Self

where T: Into<String>,

Add a label to this node

Labels are generally optional but can be helpful for named structured data, like the fields of a struct. Labels are less likely to be used for tuple structs or tuple enums.

Examples found in repository

examples/my_struct_manual.rs (line 21)

    fn associated_data(&self) -> Option<Vec<DataDescription>> {
        Some(vec![
            DataDescription::from(&self.my_u8).with_label("my_u8"),
            DataDescription::from(&self.my_string).with_label("my_string"),
            DataDescription::from(&self.my_ref).with_label("my_ref"),
        ])
    }

examples/my_enum_manual.rs (line 38)

    fn associated_data(&self) -> Option<Vec<DataDescription>> {
        match self {
            MyEnum::Plain => None,
            MyEnum::WithU8(a) => Some(vec![DataDescription::from(a)]),
            MyEnum::WithU8AndString(a, b) => {
                Some(vec![DataDescription::from(a), DataDescription::from(b)])
            }
            MyEnum::WithStruct { my_u8, my_string } => Some(vec![
                DataDescription::from(my_u8).with_label("my_u8"),
                DataDescription::from(my_string).with_label("my_string"),
            ]),
        }
    }

pub fn render_references(&self, node_name: &str) -> String

Create the DOT code to make all arrows from data owned by this node to the data they reference

The referenced nodes must be added to the graph separately.

pub fn render_table_row(&self) -> String

Create the HTML table row for this data

Trait Implementations

impl Clone for DataDescription

fn clone(&self) -> DataDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataDescription

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

Formats the value using the given formatter.

impl Default for DataDescription

fn default() -> DataDescription

Returns the “default value” for a type.

impl<T> From<&T> for DataDescription

where T: Visualize,

fn from(t: &T) -> Self

Converts to this type from the input type.