Template

Struct Template 

Source
pub struct Template<'a>(/* private fields */);
Expand description

Templating system for node and edge labels and tooltips.

This implements the Templating trait to be used in conjunction with Option<NodeColoringValues>.

Implementations§

Source§

impl<'a> Template<'a>

Source

pub fn new(template_options: &'a TemplateOptions) -> Result<Self, TemplateError>

Create a new Template from the given TemplateOptions.

§Defaults

If a template option field is None, its corresponding default is used:

  • Node label: "{short}"
  • Node tooltip: "{full}\n{size_binary}\n{features}"
  • Edge label: "{features}"
  • Edge tooltip: "{source} -> {target}"

Trait Implementations§

Source§

impl<'a> Templating for Template<'a>

Source§

type Context = Option<NodeColoringScheme>

The type of context shared across all nodes and edges.
Source§

type Value = Option<usize>

The type of value for each node.
Source§

fn node( &self, graph: &Graph, index: usize, value: Self::Value, context: Self::Context, ) -> (String, String)

Get the label and tooltip for a given node.
Source§

fn edge(&self, graph: &Graph, source: usize, target: usize) -> (String, String)

Get the label and tooltip for a given edge.

Auto Trait Implementations§

§

impl<'a> Freeze for Template<'a>

§

impl<'a> !RefUnwindSafe for Template<'a>

§

impl<'a> !Send for Template<'a>

§

impl<'a> !Sync for Template<'a>

§

impl<'a> Unpin for Template<'a>

§

impl<'a> !UnwindSafe for Template<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.