substrate/block/
mod.rs

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
//! A block that can be instantiated by Substrate.

use std::any::Any;
use std::hash::Hash;
use std::sync::Arc;

pub use codegen::Block;

use crate::arcstr::ArcStr;
use crate::types::Io;

#[cfg(test)]
mod tests;

/// A block that can be instantiated by Substrate.
///
/// # Examples
///
#[doc = snippets::include_snippet!("substrate", "inverter")]
pub trait Block: Hash + Eq + Send + Sync + Any {
    /// The ports of this block.
    type Io: Io;

    /// A name for a specific parametrization of this block.
    ///
    /// Instances of this block will initially be assigned this name,
    /// although Substrate may need to change the name
    /// (e.g. to avoid duplicates).
    fn name(&self) -> ArcStr {
        arcstr::literal!("unnamed")
    }

    /// Returns a fully-specified instance of this cell's `Io`.
    fn io(&self) -> Self::Io;
}

impl<T: Block> Block for Arc<T> {
    type Io = T::Io;

    fn name(&self) -> ArcStr {
        T::name(self)
    }

    fn io(&self) -> Self::Io {
        T::io(self)
    }
}