Enum rustc_graphviz::LabelText

pub enum LabelText<'a> {
    LabelStr(Cow<'a, str>),
    EscStr(Cow<'a, str>),
    HtmlStr(Cow<'a, str>),
}

The text for a graphviz label on a node or edge.

Variants

LabelStr(Cow<'a, str>)

This kind of label preserves the text directly as is.

Occurrences of backslashes (\) are escaped, and thus appear as backslashes in the rendered label.

Tuple Fields of LabelStr

0: Cow<'a, str>

EscStr(Cow<'a, str>)

This kind of label uses the graphviz label escString type: https://www.graphviz.org/content/attrs#kescString

Occurrences of backslashes (\) are not escaped; instead they are interpreted as initiating an escString escape sequence.

Escape sequences of particular interest: in addition to \n to break a line (centering the line preceding the \n), there are also the escape sequences \l which left-justifies the preceding line and \r which right-justifies it.

Tuple Fields of EscStr

0: Cow<'a, str>

HtmlStr(Cow<'a, str>)

This uses a graphviz HTML string label. The string is printed exactly as given, but between < and >. No escaping is performed.

Tuple Fields of HtmlStr

0: Cow<'a, str>

Implementations

impl<'a> LabelText<'a>

pub fn label<S: Into<Cow<'a, str>>>(s: S) -> LabelText<'a>

pub fn html<S: Into<Cow<'a, str>>>(s: S) -> LabelText<'a>

pub(crate) fn escape_char<F>(c: char, f: F) where
    F: FnMut(char), 

pub(crate) fn escape_str(s: &str) -> String

pub fn to_dot_string(&self) -> String

Renders text as string suitable for a label in a .dot file. This includes quotes or suitable delimiters.

pub(crate) fn pre_escaped_content(self) -> Cow<'a, str>

Decomposes content into string suitable for making EscStr that yields same content as self. The result obeys the law render(lt) == render(EscStr(lt.pre_escaped_content())) for all lt: LabelText.

pub fn suffix_line(self, suffix: LabelText<'_>) -> LabelText<'static>

Puts suffix on a line below this label, with a blank line separator.

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

Size for each variant:

• LabelStr: 32 bytes
• EscStr: 32 bytes
• HtmlStr: 32 bytes