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>

source

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

source

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

source

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

source

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

source

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.

source

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.

source

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> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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 bytes
  • EscStr: 24 bytes
  • HtmlStr: 24 bytes