Struct tydi::logical::Stream

pub struct Stream { /* fields omitted */ }

The stream-manipulating logical stream type.

Defines a new physical stream.

Reference

Methods

impl Stream

pub fn new(
    data: LogicalStreamType,
    throughput: PositiveReal,
    dimensionality: NonNegative,
    synchronicity: Synchronicity,
    complexity: impl Into<Complexity>,
    direction: Direction,
    user: Option<LogicalStreamType>,
    keep: bool
) -> Self

pub fn new_basic(data: LogicalStreamType) -> Self

pub fn data(&self) -> &LogicalStreamType

pub fn direction(&self) -> Direction

Returns the direction of this stream.

pub fn synchronicity(&self) -> Synchronicity

Returns the synchronicity of this stream.

pub fn dimensionality(&self) -> NonNegative

Returns the dimensionality of this stream.

pub fn throughput(&self) -> PositiveReal

Returns the throughput ratio of this stream.

pub fn is_null(&self) -> bool

Returns true if this stream is null i.e. it results in no signals.

Reference

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl From<Stream> for LogicalStreamType

fn from(stream: Stream) -> Self

Wraps this stream in a LogicalStreamType.

impl PartialEq<Stream> for Stream

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Reverse for Stream

fn reverse(&mut self)

Reverse the direction of this stream.

This flips the Direction of the stream.

impl StructuralPartialEq for Stream

impl Typify for Stream

fn user(&self, prefix: impl Into<String>) -> Option<Type>

This implementation for Stream assumes the parent LogicalStreamType has already been flattened through synthesize.

fn canonical(&self, prefix: impl Into<String>) -> Vec<Signal>

This implementation for Stream assumes the parent LogicalStreamType has already been flattened through synthesize.