Struct InputDiagram 

pub struct InputDiagram {

    pub things: ThingNames,
    pub thing_copy_text: ThingCopyText,
    pub thing_hierarchy: ThingHierarchy,
    pub thing_dependencies: ThingDependencies,
    pub thing_interactions: ThingInteractions,
    pub processes: Processes,
    pub tags: TagNames,
    pub tag_things: TagThings,
    pub entity_descs: EntityDescs,
    pub entity_types: EntityTypes,
    pub theme_default: ThemeDefault,
    pub theme_types_styles: ThemeTypesStyles,
    pub theme_thing_dependencies_styles: ThemeThingDependenciesStyles,
    pub theme_tag_things_focus: ThemeTagThingsFocus,
    pub css: Css,
}

The kinds of diagrams that can be generated.

This is the root data structure for diagram input, containing all configuration for things, their relationships, processes, tags, styling, and themes.

Fields

things: ThingNames

Things in the diagram and their display labels.

thing_copy_text: ThingCopyText

Text to copy to clipboard when a thing’s copy button is clicked.

This allows things to have different copy text than their display label.

thing_hierarchy: ThingHierarchy

Hierarchy of things as a recursive tree structure.

This defines the nesting of things, which affects visual containment in the diagram.

thing_dependencies: ThingDependencies

Dependencies between things (static relationships).

When B depends on A, it means A must exist before B. Changes to A means B is out of date.

thing_interactions: ThingInteractions

Interactions between things (communication between applications).

Has the same structure as dependencies but represents runtime communication rather than static dependencies.

processes: Processes

Processes are groupings of interactions between things sequenced over time.

tags: TagNames

Tags are labels that can be associated with things, so that the things can be highlighted when the tag is focused.

tag_things: TagThings

Things associated with each tag.

entity_descs: EntityDescs

Descriptions to render next to entities (things, edges, edge groups).

entity_types: EntityTypes

Additional types attached to entities for common styling.

Each entity can have multiple types, allowing styles to be stacked. These types are appended to the entity’s computed default type.

theme_default: ThemeDefault

Default theme styles when the diagram has no user interaction.

theme_types_styles: ThemeTypesStyles

Styles applied to things / edges of a particular type.

theme_thing_dependencies_styles: ThemeThingDependenciesStyles

Styles when a thing is focused to show its dependencies.

theme_tag_things_focus: ThemeTagThingsFocus

Styles when a tag is focused.

The tag_defaults key applies styles to all tags uniformly. Specific tag IDs can be used to override defaults for particular tags.

css: Css

Additional CSS to place in the SVG’s inline <styles> section.

Implementations

impl InputDiagram

pub fn new() -> Self

Returns a new InputDiagram with default values.

Trait Implementations

impl Clone for InputDiagram

fn clone(&self) -> InputDiagram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputDiagram

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

Formats the value using the given formatter.

impl Default for InputDiagram

fn default() -> InputDiagram

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InputDiagram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InputDiagram

fn eq(&self, other: &InputDiagram) -> 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 Serialize for InputDiagram

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InputDiagram

impl StructuralPartialEq for InputDiagram