Struct DependencyGraph 

pub struct DependencyGraph { /* private fields */ }

A graph of dependency relations between resources.

Dependency relations can be traversed via DependencyNodes. Any resource that has dependencies or dependents can be accessed via DependencyGraph::get().

DependencyGraphs are comparable via equivalence relations.

Implementations

impl DependencyGraph

pub fn builder() -> DependencyGraphBuilder

Create a DependencyGraphBuilder.

This can be useful to construct a populated DependencyGraph in e.g. unit tests.

pub fn clear_dependencies(&mut self, id: &ResourceId)

Clear all dependency relations for a particular resource in this graph.

use gtether::resource::id::ResourceId;
use gtether::resource::manager::dependency::DependencyGraph;

let mut graph = DependencyGraph::builder().add("a", ["b", "c"]).add("b", ["c"]).build();
let expected_graph = DependencyGraph::builder().add("b", ["c"]).build();

let id = ResourceId::from("a");
graph.clear_dependencies(&id);
assert_eq!(graph, expected_graph);
assert_eq!(graph.get(&id), None);

pub fn add_dependency(&mut self, id: ResourceId, dependency: ResourceId)

Add a dependency relation for a particular resource in this graph.

use gtether::resource::id::ResourceId;
use gtether::resource::manager::dependency::DependencyGraph;

let mut graph = DependencyGraph::builder().add("a", ["b"]).build();
let expected_graph = DependencyGraph::builder().add("a", ["b", "c"]).build();

graph.add_dependency(ResourceId::from("a"), ResourceId::from("c"));
assert_eq!(graph, expected_graph);

pub fn set_dependencies( &mut self, id: ResourceId, dependencies: impl IntoIterator<Item = ResourceId>, )

Set the dependency relations for a particular resource in this graph.

use gtether::resource::id::ResourceId;
use gtether::resource::manager::dependency::DependencyGraph;

let mut graph = DependencyGraph::builder().add("a", ["b", "c"]).build();
let expected_graph = DependencyGraph::builder().add("a", ["d", "e"]).build();

graph.set_dependencies(ResourceId::from("a"), [ResourceId::from("d"), ResourceId::from("e")]);
assert_eq!(graph, expected_graph);

pub fn get(&self, id: &ResourceId) -> Option<DependencyNode<'_>>

Get a DependencyNode for a particular resource in this graph.

If the given resource does not have any dependencies or dependents, it will not be in the graph, and so this method will return None.

use gtether::resource::id::ResourceId;
use gtether::resource::manager::dependency::DependencyGraph;

let graph = DependencyGraph::builder().add("a", ["b"]).build();

let id_a = ResourceId::from("a");
let id_b = ResourceId::from("b");
let id_c = ResourceId::from("c");

assert_eq!(graph.get(&id_a).unwrap().id(), &id_a);
assert_eq!(graph.get(&id_b).unwrap().id(), &id_b);
assert_eq!(graph.get(&id_c), None);

pub fn iter(&self) -> Iter<'_>

Iterate over all dependencies in this graph, in no particular order.

This will only iterate over nodes that have dependencies, and will not iterate over leaf nodes.

use std::collections::HashSet;
use gtether::resource::id::ResourceId;
use gtether::resource::manager::dependency::DependencyGraph;

let graph = DependencyGraph::builder().add("a", ["b", "c"]).add("b", ["c"]).build();
let expected_ids = ["a", "b"].into_iter()
    .map(ResourceId::from)
    .collect::<HashSet<_>>();

let ids = graph.iter()
    .map(|node| node.id().clone())
    .collect::<HashSet<_>>();
assert_eq!(ids, expected_ids);

Trait Implementations

impl Clone for DependencyGraph

fn clone(&self) -> DependencyGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DependencyGraph

where HashMap<ResourceId, HashSet<ResourceId>>: Debug,

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

Formats the value using the given formatter.

impl Default for DependencyGraph

fn default() -> DependencyGraph

Returns the “default value” for a type.

impl Eq for DependencyGraph

impl PartialEq for DependencyGraph

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DependencyGraph