tydi 0.0.7

An HDL code generation utility for components described using the Tydi open specification.
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! This module contains the Streamlet structure.
//!
//! A streamlet is a component where every [Interface] has a [LogicalStreamType].

use crate::logical::LogicalStreamType;
use crate::traits::Identify;
use crate::util::UniquelyNamedBuilder;
use crate::{Error, Name, Result};
use std::convert::TryInto;
use std::str::FromStr;

/// Streamlet interface definition.
#[derive(Clone, Debug, PartialEq)]
pub struct Streamlet {
    name: Name,
    interfaces: Vec<Interface>,
}

impl Streamlet {
    pub fn interfaces(&self) -> Vec<Interface> {
        self.interfaces.clone()
    }

    pub fn from_builder(name: Name, builder: UniquelyNamedBuilder<Interface>) -> Result<Self> {
        Ok(Streamlet {
            name,
            interfaces: builder.finish()?,
        })
    }
}

impl Identify for Streamlet {
    fn identifier(&self) -> &str {
        self.name.as_ref()
    }
}

/// Streamlet interface mode.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Mode {
    /// The interface is an output of the streamlet.
    Out,
    /// The interface is an input of the streamlet.
    In,
}

impl FromStr for Mode {
    type Err = Error;

    fn from_str(input: &str) -> Result<Self> {
        match input {
            "in" => Ok(Mode::In),
            "out" => Ok(Mode::Out),
            _ => Err(Error::InvalidArgument(format!(
                "{} is not a valid interface Mode. Expected \"in\" or \"out\"",
                input
            ))),
        }
    }
}

#[derive(Clone, Debug, PartialEq)]
pub struct Interface {
    name: Name,
    mode: Mode,
    typ: LogicalStreamType,
}

impl Interface {
    pub fn mode(&self) -> Mode {
        self.mode
    }

    pub fn typ(&self) -> LogicalStreamType {
        self.typ.clone()
    }
}

impl crate::traits::Identify for Interface {
    fn identifier(&self) -> &str {
        self.name.as_ref()
    }
}

type BoxedStdError = Box<dyn std::error::Error>;

impl Interface {
    pub fn new(name: impl Into<Name>, mode: Mode, typ: impl Into<LogicalStreamType>) -> Self {
        Interface {
            name: name.into(),
            mode,
            typ: typ.into(),
        }
    }
    pub fn try_new(
        name: impl TryInto<Name, Error = impl Into<BoxedStdError>>,
        mode: Mode,
        typ: impl TryInto<LogicalStreamType, Error = impl Into<BoxedStdError>>,
    ) -> Result<Self> {
        Ok(Interface {
            name: name.try_into().map_err(Into::into)?,
            mode,
            typ: typ.try_into().map_err(Into::into)?,
        })
    }
}