Skip to main content

Node

Struct Node 

Source
pub struct Node {
    pub id: String,
    pub label: String,
    pub shape: NodeShape,
}
Expand description

A single node in the diagram.

Fields§

§id: String

Unique identifier used in edge definitions (e.g. A).

§label: String

Human-readable label displayed inside the node box.

§shape: NodeShape

Visual shape of the node.

Implementations§

Source§

impl Node

Source

pub fn new( id: impl Into<String>, label: impl Into<String>, shape: NodeShape, ) -> Self

Construct a new node.

§Arguments
  • id — unique identifier used in edge definitions
  • label — human-readable text displayed inside the node box
  • shape — visual shape of the node
§Examples
use mermaid_text::{Node, NodeShape};

let node = Node::new("A", "Start", NodeShape::Rounded);
assert_eq!(node.id, "A");
assert_eq!(node.label, "Start");
assert_eq!(node.shape, NodeShape::Rounded);
Source

pub fn label_width(&self) -> usize

Return the widest line of the label, measured in terminal cells.

Labels may contain \n line breaks (inserted by the parser when converting <br/> tags or when soft-wrapping long lines). The renderer sizes node boxes by the widest single line rather than by the whole label string, so the parser-inserted breaks actually narrow the box.

Returns 0 for an empty label.

Source

pub fn label_line_count(&self) -> usize

Return the number of rendered text rows this node’s label occupies.

Always at least 1, even for empty labels, so node boxes retain their minimum height.

Trait Implementations§

Source§

impl Clone for Node

Source§

fn clone(&self) -> Node

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Node

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Node

Source§

fn eq(&self, other: &Node) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Node

Source§

impl StructuralPartialEq for Node

Auto Trait Implementations§

§

impl Freeze for Node

§

impl RefUnwindSafe for Node

§

impl Send for Node

§

impl Sync for Node

§

impl Unpin for Node

§

impl UnsafeUnpin for Node

§

impl UnwindSafe for Node

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.