Struct AttributedGraphBuilder 

pub struct AttributedGraphBuilder<N, E> { /* private fields */ }

Builder for AttributedGraph that provides a fluent API.

Example

use scirs2_graph::attributed_graph::{AttributedGraphBuilder, NodeId};

let mut builder: AttributedGraphBuilder<f64, f32> = AttributedGraphBuilder::new();
let a = builder.node(1.0);
let b = builder.node(2.0);
builder.edge(a, b, 0.5_f32);
let graph = builder.build().expect("build failed");
assert_eq!(graph.node_count(), 2);
assert_eq!(graph.edge_count(), 1);

Implementations

impl<N, E> AttributedGraphBuilder<N, E>

pub fn new() -> Self

Create a new empty builder.

pub fn with_capacity(node_capacity: usize, edge_capacity: usize) -> Self

Create a builder with capacity hints.

pub fn node(&mut self, data: N) -> NodeId

Add a node; returns the assigned NodeId.

pub fn edge(&mut self, src: NodeId, dst: NodeId, data: E) -> &mut Self

Add a directed edge. Any error is deferred until build.

pub fn build(self) -> Result<AttributedGraph<N, E>>

Consume the builder and return the graph.

Errors

Returns the first deferred error, if any.

pub fn build_unchecked(self) -> AttributedGraph<N, E>

Consume the builder, returning the graph without checking errors.

Silently drops any accumulated errors.

Trait Implementations

impl<N: Debug, E: Debug> Debug for AttributedGraphBuilder<N, E>

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

Formats the value using the given formatter.

impl<N, E> Default for AttributedGraphBuilder<N, E>

fn default() -> Self

Returns the “default value” for a type.