Struct FieldCodecEngine
pub struct FieldCodecEngine { /* private fields */ }Expand description
Serial canonical encoder/decoder for field elements.
Decode mode validates canonicality by re-encoding the parsed value and comparing all 32 bytes with the original input.
Trait Implementations§
§impl Clone for FieldCodecEngine
impl Clone for FieldCodecEngine
§fn clone(&self) -> FieldCodecEngine
fn clone(&self) -> FieldCodecEngine
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read more§impl Debug for FieldCodecEngine
impl Debug for FieldCodecEngine
§impl Default for FieldCodecEngine
impl Default for FieldCodecEngine
§fn default() -> FieldCodecEngine
fn default() -> FieldCodecEngine
Returns the “default value” for a type. Read more
§impl Synchronous for FieldCodecEngine
impl Synchronous for FieldCodecEngine
§type S = (<FieldCodecEngine as SynchronousDQ>::Q, <DFF<FieldCodecRegs> as Synchronous>::S, <SyncBRAM<Bits<64>, 4> as Synchronous>::S)
type S = (<FieldCodecEngine as SynchronousDQ>::Q, <DFF<FieldCodecRegs> as Synchronous>::S, <SyncBRAM<Bits<64>, 4> as Synchronous>::S)
The simulation state type.
This type is used to represent the internal state of the circuit
during simulation. It must be
PartialEq and Clone. It holds whatever
state is needed to compute the output of the circuit given it’s input.
This state is typically auto-derived by the Synchronous derive macro,
and it’s typically a struct containing the states of all the subcircuits,
along with their last know outputs.§fn init(&self) -> <FieldCodecEngine as Synchronous>::S
fn init(&self) -> <FieldCodecEngine as Synchronous>::S
Initialize the simulation state.
This method returns the initial state of the circuit for simulation.
This is typically auto-derived by the
Synchronous derive macro,
and it typically initializes the states of all the subcircuits to their
initial states.§fn children(
&self,
parent_scope: &ScopedName,
) -> impl Iterator<Item = Result<Descriptor<SyncKind>, RHDLError>>
fn children( &self, parent_scope: &ScopedName, ) -> impl Iterator<Item = Result<Descriptor<SyncKind>, RHDLError>>
Iterate over the child circuits of this circuit.
§fn sim(
&self,
clock_reset: ClockReset,
input: <FieldCodecEngine as SynchronousIO>::I,
state: &mut <FieldCodecEngine as Synchronous>::S,
) -> <FieldCodecEngine as SynchronousIO>::O
fn sim( &self, clock_reset: ClockReset, input: <FieldCodecEngine as SynchronousIO>::I, state: &mut <FieldCodecEngine as Synchronous>::S, ) -> <FieldCodecEngine as SynchronousIO>::O
Simulate the circuit given it’s input, clock reset, and current state.
§fn descriptor(
&self,
scoped_name: ScopedName,
) -> Result<Descriptor<SyncKind>, RHDLError>
fn descriptor( &self, scoped_name: ScopedName, ) -> Result<Descriptor<SyncKind>, RHDLError>
Provides run time reflection of the circuit.
§impl SynchronousDQ for FieldCodecEngine
impl SynchronousDQ for FieldCodecEngine
§impl SynchronousIO for FieldCodecEngine
impl SynchronousIO for FieldCodecEngine
§type I = FieldCodecIn
type I = FieldCodecIn
The type of the input to the circuit.
§type O = FieldCodecOut
type O = FieldCodecOut
The type of the output from the circuit.
§type Kernel = field_codec_engine_kernel
type Kernel = field_codec_engine_kernel
The type of the kernel function used to compute the output and feedback.
The kernel function must be a synthesizable function that takes a clock and reset signal,
the input signal, and the feedback signal Q, and produces the output signal and feedback signal D. Read more
Auto Trait Implementations§
impl Freeze for FieldCodecEngine
impl RefUnwindSafe for FieldCodecEngine
impl Send for FieldCodecEngine
impl Sync for FieldCodecEngine
impl Unpin for FieldCodecEngine
impl UnsafeUnpin for FieldCodecEngine
impl UnwindSafe for FieldCodecEngine
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<D> OwoColorize for D
impl<D> OwoColorize for D
§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Set the foreground color generically Read more
§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Set the background color generically. Read more
§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to magenta
§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Change the foreground color to the terminal default
§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Change the background color to the terminal default
§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Change the foreground color to bright black
§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Change the background color to bright black
§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Change the foreground color to bright red
§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Change the background color to bright red
§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Change the foreground color to bright green
§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Change the background color to bright green
§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Change the foreground color to bright yellow
§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Change the background color to bright yellow
§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Change the foreground color to bright blue
§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Change the background color to bright blue
§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright magenta
§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright magenta
§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright purple
§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright purple
§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Change the foreground color to bright cyan
§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Change the background color to bright cyan
§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Change the foreground color to bright white
§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Change the background color to bright white
§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Make the text blink (but fast!)
Hide the text
§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Cross out the text
§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either [
OwoColorize::fg] or
a color-specific method, such as [OwoColorize::green], Read more§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either [
OwoColorize::bg] or
a color-specific method, such as [OwoColorize::on_yellow], Read more§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Sets the foreground color to an RGB value.
§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
Sets the background color to an RGB value.
§impl<T, I> RunSynchronousExt<I> for Twhere
T: Synchronous,
I: IntoIterator<Item = TimedSample<(ClockReset, <T as SynchronousIO>::I)>>,
impl<T, I> RunSynchronousExt<I> for Twhere
T: Synchronous,
I: IntoIterator<Item = TimedSample<(ClockReset, <T as SynchronousIO>::I)>>,
§fn run(
&self,
iter: I,
) -> RunSynchronous<'_, T, <I as IntoIterator>::IntoIter, <T as Synchronous>::S>
fn run( &self, iter: I, ) -> RunSynchronous<'_, T, <I as IntoIterator>::IntoIter, <T as Synchronous>::S>
Runs the circuit with the given iterator of timed inputs.
§impl<T> RunSynchronousFeedbackExt for Twhere
T: Synchronous,
impl<T> RunSynchronousFeedbackExt for Twhere
T: Synchronous,
§impl<I, P, O> SynchronousProbeExt<I, P, O> for I
impl<I, P, O> SynchronousProbeExt<I, P, O> for I
§fn synchronous_sample(self) -> SynchronousSample<I>where
I: Iterator<Item = TracedSample<(ClockReset, P), O>>,
P: Digital,
O: Digital,
fn synchronous_sample(self) -> SynchronousSample<I>where
I: Iterator<Item = TracedSample<(ClockReset, P), O>>,
P: Digital,
O: Digital,
Create a probe that samples values from the supplied stream
just before a positive edge of the clock