neco-nodegraph 0.1.0

necosystems series node graph data model with port-typed nodes and edges
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use alloc::string::{String, ToString};

use crate::error::GraphError;
use crate::id::PortId;

/// Port direction used for edge validation.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PortDirection {
    Input,
    Output,
}

/// A typed port belonging to a node.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Port {
    id: PortId,
    direction: PortDirection,
    type_tag: String,
}

impl Port {
    /// Creates a port. `type_tag` must not be empty.
    pub fn new(id: PortId, direction: PortDirection, type_tag: &str) -> Result<Self, GraphError> {
        if type_tag.is_empty() {
            return Err(GraphError::EmptyTypeTag);
        }

        Ok(Self {
            id,
            direction,
            type_tag: type_tag.to_string(),
        })
    }

    /// Returns the port identifier.
    pub fn id(&self) -> &PortId {
        &self.id
    }

    /// Returns the direction used for connection validation.
    pub const fn direction(&self) -> PortDirection {
        self.direction
    }

    /// Returns the application-defined type tag.
    pub fn type_tag(&self) -> &str {
        self.type_tag.as_str()
    }
}