Struct Graph 

pub struct Graph { /* private fields */ }

A safe, idiomatic Rust wrapper around a C++ odgi::graph_t object.

A Graph instance represents a pangenome graph loaded into memory. Once loaded, you can use its methods to perform various queries, such as retrieving node sequences, finding paths, and traversing the graph structure.

The only way to create a Graph is by calling Graph::load.

Implementations

impl Graph

pub fn load(_path: &str) -> Result<Self, Error>

Loads an ODGI graph from a file into memory.

pub fn node_count(&self) -> u64

Returns the total number of nodes in the graph.

pub fn get_path_names(&self) -> Vec<String>

Returns a list of all path names in the graph.

pub fn project(&self, _path_name: &str, _pos: u64) -> Option<PathPosition>

Projects a 0-based linear coordinate on a path to graph coordinates.

pub fn get_node_sequence(&self, _node_id: u64) -> String

Gets the DNA sequence for a given node ID.

pub fn get_node_len(&self, _node_id: u64) -> u64

Gets the length of the sequence for a given node ID.

pub fn get_successors(&self, _node_id: u64) -> Vec<Edge>

Gets all successor edges for a given node ID.

pub fn get_predecessors(&self, _node_id: u64) -> Vec<Edge>

Gets all predecessor edges for a given node ID.

pub fn get_paths_on_node(&self, _node_id: u64) -> Vec<String>

Gets the names of all paths that step on a given node ID.

pub fn get_path_length(&self, _path_name: &str) -> Option<u64>

Gets the total length of a path in base pairs.

pub fn get_paths_on_edge( &self, _from_node: u64, _from_orientation: bool, _to_node: u64, _to_orientation: bool, ) -> Vec<String>

Gets the names of all paths that traverse a specific directed edge.

Trait Implementations

impl Send for Graph

Marks the Graph struct as safe to send between threads.

impl Sync for Graph

Marks the Graph struct as safe to share between threads.