Struct BlockInfo 

pub struct BlockInfo {
    pub name: &'static str,
    pub summary: &'static str,
    pub params: Vec<ParamInfo>,
    pub needs: &'static [Fact],
    pub gives: &'static [Fact],
    pub starts: bool,
    pub per_polarization: bool,
}

The documentation of a block: its parameters and its ports.

Fields

name: &'static str

The type of the block.

summary: &'static str

What it does.

params: Vec<ParamInfo>

Its parameters.

needs: &'static [Fact]

The facts of the frame it reads.

gives: &'static [Fact]

The facts it may add to the frame.

starts: bool

Whether it starts a link (it draws or reads the transmitted signal).

per_polarization: bool

Whether it is written for one polarisation: with a dual-polarisation channel (Layout::polarisations) each polarisation goes through it with its own symbols.

Implementations

impl BlockInfo

pub fn describe(&self) -> String

The block as text (name, summary, ports, one line per parameter).

pub fn to_json(&self) -> Json

The block as JSON: name, summary, ports and the JSON Schema of every parameter.

Trait Implementations

impl Clone for BlockInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockInfo

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

Formats the value using the given formatter.