Skip to main content

GraphDesc

Struct GraphDesc 

Source
pub struct GraphDesc {
    pub nodes: Vec<NodeDesc>,
    pub edges: Vec<EdgeDesc>,
}
Expand description

A whole graph description: the single input type of every layout pass.

Node and edge ORDER is meaningful: it is the deterministic tiebreak for every heuristic in this crate (same GraphDesc in, same crate::Layout out — golden-test-pinned).

use abstracttui_graph::{layered, GraphDesc, LayeredOpts};

let desc = GraphDesc::new()
    .node("a", 8, 3)
    .node("b", 8, 3)
    .edge("a", "b");
let layout = layered(&desc, &LayeredOpts::default());
assert_eq!(layout.nodes.len(), 2);

Fields§

§nodes: Vec<NodeDesc>

Nodes, in caller order.

§edges: Vec<EdgeDesc>

Edges, in caller order. Layout edges echo their index here so metadata (label/style) maps back even with duplicate endpoints.

Implementations§

Source§

impl GraphDesc

Source

pub fn new() -> Self

An empty graph.

Source

pub fn node(self, id: impl Into<String>, w: i32, h: i32) -> Self

Append a node (fluent form of pushing a NodeDesc).

Source

pub fn with_node(self, node: NodeDesc) -> Self

Append a fully-specified node.

Source

pub fn edge(self, from: impl Into<String>, to: impl Into<String>) -> Self

Append an edge (fluent form of pushing an EdgeDesc).

Source

pub fn with_edge(self, edge: EdgeDesc) -> Self

Append a fully-specified edge.

Trait Implementations§

Source§

impl Clone for GraphDesc

Source§

fn clone(&self) -> GraphDesc

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 GraphDesc

Source§

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

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

impl Default for GraphDesc

Source§

fn default() -> GraphDesc

Returns the “default value” for a type. Read more
Source§

impl Eq for GraphDesc

Source§

impl PartialEq for GraphDesc

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GraphDesc

Auto Trait Implementations§

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 = !

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.