Struct Signal

pub struct Signal { /* private fields */ }

A diagram signal line with a set of cycles.

Implementations

impl Signal

pub fn with( name: String, cycles: Vec<CycleState>, data: Vec<String>, node: String, period: u16, phase: CycleOffset, ) -> Self

Create a new Signal with a set of parameters.

pub fn new() -> Self

Create a new empty signal

pub fn with_cycle_str(states: impl AsRef<str>) -> Self

Create a new Signal with the cycles formed from the states string.

pub fn add_cycles(self, cycles: impl IntoIterator<Item = CycleState>) -> Self

Add a set of CycleStates to the Signal.

pub fn add_cycle(self, cycle: CycleState) -> Self

Add a CycleState to the Signal.

pub fn add_n_cycles(self, n: usize, cycle: CycleState) -> Self

Add a CycleState to repeat n times to the Signal.

pub fn add_nodes(self, nodes: impl AsRef<str>) -> Self

Add a set of nodes to the Signal.

This is used for putting markers and arrows / edges on the diagram. For more information look at the edges documentation.

pub fn add_node(self, node: Option<char>) -> Self

Add a node to the Signal.

This is used for putting markers and arrows / edges on the diagram. For more information look at the edges documentation.

pub fn add_data_fields( self, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Add a set of nodes to the Signal.

This is used for putting markers and arrows / edges on the diagram. For more information look at the edges documentation.

pub fn add_data_field(self, data: impl Into<String>) -> Self

Add a data field to the Signal.

This is used to fill up a container state, such as the CycleState::Data or CycleState::Box2, with text.

pub fn repeated(state: CycleState, repeats: usize) -> Self

Create a Signal that contains the state a number of times. Namely, repeats times.

pub fn period(self, period: u16) -> Self

Set the period for a signal. This is mostly important for clock signals.

pub fn phase(self, phase: impl Into<CycleOffset>) -> Self

Set the phase for a Signal. This is mostly important for clock signals.

pub fn name(self, name: impl Into<String>) -> Self

Set the name for a Signal

pub fn get_name(&self) -> &str

Get the name of the Signal.

pub fn get_nodes(&self) -> &str

Get the nodes of the Signal.

pub fn get_data_fields(&self) -> &[String]

Get the data of the Signal.

pub fn get_phase(&self) -> CycleOffset

Get the phase of the Signal.

pub fn get_period(&self) -> u16

Get the period of the Signal.

pub fn cycles(&self) -> &[CycleState]

Get the cycles that a signal currently contains.

Trait Implementations

impl Clone for Signal

fn clone(&self) -> Signal

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Signal

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

Formats the value using the given formatter.

impl Default for Signal

fn default() -> Self

Returns the “default value” for a type.

impl From<Signal> for FigureSection

fn from(wave: Signal) -> Self

Converts to this type from the input type.

impl From<SignalObject> for Signal

Available on crate feature serde only.

fn from(item: SignalObject) -> Self

Converts to this type from the input type.