Struct GraphBuilder 

pub struct GraphBuilder { /* private fields */ }

Builder for assembling an initial graph document before handing it to runtime mutation APIs.

The builder keeps direct collection writes out of Graph’s public API while still making fixtures, importers, and graph generators straightforward. Use GraphBuilder::build when the result should satisfy graph invariants, or GraphBuilder::build_unchecked only for tests and migrations that intentionally inspect invalid graphs.

Implementations

impl GraphBuilder

pub fn new(graph_id: GraphId) -> Self

Creates an empty builder for the given graph id.

pub fn graph_id(&self) -> GraphId

Returns the graph id being built.

pub fn graph(&self) -> &Graph

Borrows the current graph snapshot.

pub fn with_import(self, id: GraphId, import: GraphImport) -> Self

Adds or replaces an import.

pub fn with_symbol(self, id: SymbolId, symbol: Symbol) -> Self

Adds or replaces a symbol.

pub fn with_node(self, id: NodeId, node: Node) -> Self

Adds or replaces a node.

pub fn with_port(self, id: PortId, port: Port) -> Self

Adds or replaces a port.

pub fn with_edge(self, id: EdgeId, edge: Edge) -> Self

Adds or replaces an edge.

pub fn with_group(self, id: GroupId, group: Group) -> Self

Adds or replaces a group.

pub fn with_sticky_note(self, id: StickyNoteId, note: StickyNote) -> Self

Adds or replaces a sticky note.

pub fn with_binding(self, id: BindingId, binding: Binding) -> Self

Adds or replaces a binding.

pub fn insert_import( &mut self, id: GraphId, import: GraphImport, ) -> Option<GraphImport>

Inserts or replaces an import in-place.

pub fn update_import<R>( &mut self, id: &GraphId, f: impl FnOnce(&mut GraphImport) -> R, ) -> Option<R>

Updates an import in-place.

pub fn remove_import(&mut self, id: &GraphId) -> Option<GraphImport>

Removes an import in-place.

pub fn clear_imports(&mut self)

Clears imports in-place.

pub fn retain_imports( &mut self, f: impl FnMut(&GraphId, &mut GraphImport) -> bool, )

Retains imports matching f.

pub fn insert_symbol(&mut self, id: SymbolId, symbol: Symbol) -> Option<Symbol>

Inserts or replaces a symbol in-place.

pub fn update_symbol<R>( &mut self, id: &SymbolId, f: impl FnOnce(&mut Symbol) -> R, ) -> Option<R>

Updates a symbol in-place.

pub fn remove_symbol(&mut self, id: &SymbolId) -> Option<Symbol>

Removes a symbol in-place.

pub fn clear_symbols(&mut self)

Clears symbols in-place.

pub fn retain_symbols(&mut self, f: impl FnMut(&SymbolId, &mut Symbol) -> bool)

Retains symbols matching f.

pub fn insert_node(&mut self, id: NodeId, node: Node) -> Option<Node>

Inserts or replaces a node in-place.

pub fn update_node<R>( &mut self, id: &NodeId, f: impl FnOnce(&mut Node) -> R, ) -> Option<R>

Updates a node in-place.

pub fn remove_node(&mut self, id: &NodeId) -> Option<Node>

Removes a node in-place.

pub fn clear_nodes(&mut self)

Clears nodes in-place.

pub fn retain_nodes(&mut self, f: impl FnMut(&NodeId, &mut Node) -> bool)

Retains nodes matching f.

pub fn insert_port(&mut self, id: PortId, port: Port) -> Option<Port>

Inserts or replaces a port in-place.

pub fn update_port<R>( &mut self, id: &PortId, f: impl FnOnce(&mut Port) -> R, ) -> Option<R>

Updates a port in-place.

pub fn remove_port(&mut self, id: &PortId) -> Option<Port>

Removes a port in-place.

pub fn clear_ports(&mut self)

Clears ports in-place.

pub fn retain_ports(&mut self, f: impl FnMut(&PortId, &mut Port) -> bool)

Retains ports matching f.

pub fn insert_edge(&mut self, id: EdgeId, edge: Edge) -> Option<Edge>

Inserts or replaces an edge in-place.

pub fn update_edge<R>( &mut self, id: &EdgeId, f: impl FnOnce(&mut Edge) -> R, ) -> Option<R>

Updates an edge in-place.

pub fn remove_edge(&mut self, id: &EdgeId) -> Option<Edge>

Removes an edge in-place.

pub fn clear_edges(&mut self)

Clears edges in-place.

pub fn retain_edges(&mut self, f: impl FnMut(&EdgeId, &mut Edge) -> bool)

Retains edges matching f.

pub fn insert_group(&mut self, id: GroupId, group: Group) -> Option<Group>

Inserts or replaces a group in-place.

pub fn update_group<R>( &mut self, id: &GroupId, f: impl FnOnce(&mut Group) -> R, ) -> Option<R>

Updates a group in-place.

pub fn remove_group(&mut self, id: &GroupId) -> Option<Group>

Removes a group in-place.

pub fn clear_groups(&mut self)

Clears groups in-place.

pub fn retain_groups(&mut self, f: impl FnMut(&GroupId, &mut Group) -> bool)

Retains groups matching f.

pub fn insert_sticky_note( &mut self, id: StickyNoteId, note: StickyNote, ) -> Option<StickyNote>

Inserts or replaces a sticky note in-place.

pub fn update_sticky_note<R>( &mut self, id: &StickyNoteId, f: impl FnOnce(&mut StickyNote) -> R, ) -> Option<R>

Updates a sticky note in-place.

pub fn remove_sticky_note(&mut self, id: &StickyNoteId) -> Option<StickyNote>

Removes a sticky note in-place.

pub fn clear_sticky_notes(&mut self)

Clears sticky notes in-place.

pub fn retain_sticky_notes( &mut self, f: impl FnMut(&StickyNoteId, &mut StickyNote) -> bool, )

Retains sticky notes matching f.

pub fn insert_binding( &mut self, id: BindingId, binding: Binding, ) -> Option<Binding>

Inserts or replaces a binding in-place.

pub fn update_binding<R>( &mut self, id: &BindingId, f: impl FnOnce(&mut Binding) -> R, ) -> Option<R>

Updates a binding in-place.

pub fn remove_binding(&mut self, id: &BindingId) -> Option<Binding>

Removes a binding in-place.

pub fn clear_bindings(&mut self)

Clears bindings in-place.

pub fn retain_bindings( &mut self, f: impl FnMut(&BindingId, &mut Binding) -> bool, )

Retains bindings matching f.

pub fn build(self) -> Result<Graph, Vec<GraphValidationError>>

Validates and returns the assembled graph.

pub fn build_unchecked(self) -> Graph

Returns the graph without validation.

Prefer GraphBuilder::build for normal construction. This is useful for tests and migration tooling that intentionally produce invalid graphs and then assert diagnostics.

Methods from Deref<Target = Graph>

pub fn graph_id(&self) -> GraphId

Returns the stable graph identity.

pub fn graph_version(&self) -> u32

Returns the schema version.

pub fn imports(&self) -> GraphElements<'_, GraphId, GraphImport>

Returns graph imports.

pub fn import(&self, id: &GraphId) -> Option<&GraphImport>

Returns one graph import.

pub fn symbols(&self) -> GraphElements<'_, SymbolId, Symbol>

Returns graph symbols.

pub fn symbol(&self, id: &SymbolId) -> Option<&Symbol>

Returns one symbol.

pub fn nodes(&self) -> GraphElements<'_, NodeId, Node>

Returns graph nodes.

Examples found in repository

examples/build_graph.rs (line 43)

fn main() {
    let node_id = NodeId::from_u128(2);
    let mut graph = Graph::new(GraphId::from_u128(1));

    let mut tx = GraphTransaction::new().with_label("add source node");
    tx.push(GraphOp::AddNode {
        id: node_id,
        node: make_node("demo.source", 10.0, 20.0),
    });
    tx.apply_to(&mut graph).expect("transaction applies");

    assert_eq!(graph.nodes().len(), 1);
    assert_eq!(
        graph.nodes()[&node_id].kind,
        NodeKindKey::new("demo.source")
    );
}

pub fn node(&self, id: &NodeId) -> Option<&Node>

Returns one node.

pub fn ports(&self) -> GraphElements<'_, PortId, Port>

Returns graph ports.

pub fn port(&self, id: &PortId) -> Option<&Port>

Returns one port.

pub fn edges(&self) -> GraphElements<'_, EdgeId, Edge>

Returns graph edges.

pub fn edge(&self, id: &EdgeId) -> Option<&Edge>

Returns one edge.

pub fn groups(&self) -> GraphElements<'_, GroupId, Group>

Returns graph groups.

pub fn group(&self, id: &GroupId) -> Option<&Group>

Returns one group.

pub fn sticky_notes(&self) -> GraphElements<'_, StickyNoteId, StickyNote>

Returns sticky notes.

pub fn sticky_note(&self, id: &StickyNoteId) -> Option<&StickyNote>

Returns one sticky note.

pub fn bindings(&self) -> GraphElements<'_, BindingId, Binding>

Returns bindings.

pub fn binding(&self, id: &BindingId) -> Option<&Binding>

Returns one binding.

Trait Implementations

impl AsRef<Graph> for GraphBuilder

fn as_ref(&self) -> &Graph

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for GraphBuilder

fn clone(&self) -> GraphBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphBuilder

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

Formats the value using the given formatter.

impl Default for GraphBuilder

fn default() -> GraphBuilder

Returns the “default value” for a type.

impl Deref for GraphBuilder

type Target = Graph

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<GraphBuilder> for Graph

fn from(builder: GraphBuilder) -> Self

Converts to this type from the input type.