RustHdlModule

Struct RustHdlModule 

Source
pub struct RustHdlModule {
    pub name: String,
    pub signals: Vec<Signal>,
    /* private fields */
}
Expand description

Represents a rust-hdl module.

It should be trivial to generate a wrapping rust-hdl module from this struct.

Fields§

§name: String

Name for the rust-hdl struct

§signals: Vec<Signal>

The interface of the rust-hdl module

Implementations§

Source§

impl RustHdlModule

Source

pub fn new(verilog_name: String, signals: Vec<Signal>, verilog: String) -> Self

Source

pub fn internal_verilog(&self) -> String

Verilog that should be used as the internal logic of the rust-hdl module.

It just instantiates the external module and connects the ports.

Source

pub fn external_verilog(&self) -> &str

Verilog that contains the module that is being wrapped.

This needs to be included besides the internal verilog.

Source

pub fn verilog_name(&self) -> &str

The name of the verilog module that is being wrapped.

Trait Implementations§

Source§

impl Debug for RustHdlModule

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RustHdlModule

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for RustHdlModule

Source§

impl StructuralPartialEq for RustHdlModule

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.