Enum rustc_graphviz::LabelText
source · pub enum LabelText<'a> {
LabelStr(Cow<'a, str>),
EscStr(Cow<'a, str>),
HtmlStr(Cow<'a, str>),
}
Expand description
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.
EscStr(Cow<'a, str>)
This kind of label uses the graphviz label escString type: https://www.graphviz.org/docs/attr-types/escString
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.
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.
Implementations§
source§impl<'a> LabelText<'a>
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
sourcepub fn to_dot_string(&self) -> 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.
sourcepub(crate) fn pre_escaped_content(self) -> Cow<'a, str>
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
.
sourcepub fn suffix_line(self, suffix: LabelText<'_>) -> LabelText<'static>
pub fn suffix_line(self, suffix: LabelText<'_>) -> LabelText<'static>
Puts suffix
on a line below this label, with a blank line separator.
Auto Trait Implementations§
impl<'a> RefUnwindSafe for LabelText<'a>
impl<'a> Send for LabelText<'a>
impl<'a> Sync for LabelText<'a>
impl<'a> Unpin for LabelText<'a>
impl<'a> UnwindSafe for LabelText<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
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: 32 bytes
Size for each variant:
LabelStr
: 24 bytesEscStr
: 24 bytesHtmlStr
: 24 bytes