Struct Relations 

pub struct Relations { /* private fields */ }

The typed edges of a code system, both ways.

Implementations

impl Relations

pub fn build( nodes: u32, types: Vec<String>, edges: Vec<(Ordinal, u32, Ordinal)>, ) -> Result<Self, RelationsError>

Builds the relations of nodes nodes from (source, type, target) edges.

Errors

Returns RelationsError::OutOfRange for an edge beyond nodes or beyond the type list.

pub fn types(&self) -> &[String]

The relationship type names.

pub fn kind(&self, name: &str) -> Option<u32>

The index of the type name.

pub fn nodes(&self) -> u32

The node count.

pub fn edges(&self) -> usize

The edge count.

pub fn outgoing( &self, node: Ordinal, ) -> impl Iterator<Item = (u32, Ordinal)> + '_

The (type, target) pairs leaving node, by type then target.

pub fn incoming( &self, node: Ordinal, ) -> impl Iterator<Item = (u32, Ordinal)> + '_

The (type, source) pairs arriving at node, by type then source.

pub fn sources( &self, node: Ordinal, kind: u32, ) -> impl Iterator<Item = Ordinal> + '_

The sources of edges of type kind arriving at node.

pub fn targets( &self, node: Ordinal, kind: u32, ) -> impl Iterator<Item = Ordinal> + '_

The targets of edges of type kind leaving node.

pub fn write_to(&self, out: &mut impl Write) -> Result<(), RelationsError>

Writes the layout.

Errors

Returns RelationsError::Io when writing fails.

pub fn read_from(input: &mut impl Read) -> Result<Self, RelationsError>

Reads the layout.

Errors

Returns RelationsError for a truncated, foreign, or inconsistent artifact.

Trait Implementations

impl Clone for Relations

fn clone(&self) -> Relations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Relations

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

Formats the value using the given formatter.

impl Default for Relations

fn default() -> Relations

Returns the “default value” for a type.

impl Eq for Relations

impl PartialEq for Relations

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Relations