Copyright	(c) Matthew Naylor 2019
License	MIT
Maintainer	mattfn@gmail.com
Stability	experimental
Safe Haskell	Safe-Inferred
Language	GHC2021

Blarney.Stream

Description

Synopsis

type Stream a = Source a
data Source t = Source {
- canPeek :: Bit 1
- peek :: t
- consume :: Action ()
}
toStream :: ToSource a b => a -> Stream b
nullStream :: Bits a => Stream a
guardStream :: (a -> Bit 1) -> Stream a -> Stream a
type SP t0 t1 = Stream t0 -> Module (Stream t1)
class ToSP a t0 t1 | a -> t0 t1 where
- toSP :: a -> SP t0 t1

Documentation

type Stream a = Source a Source #

Stream interface

data Source t Source #

Source type. A Source t Interface returns values of type t via its $sel:peek:Source method and flow control through its $sel:canPeek:Source and $sel:consume:Source methods.

Constructors

Source

Fields

canPeek :: Bit 1
Checks whether a value can be $sel:peek:Sourceed or $sel:consume:Sourced on this cycle.
peek :: t
Returns the value that the Source is producing this cycle. The value is only relevant on a cycle where $sel:canPeek:Source is true.
consume :: Action ()
Consumes a value from the Source. $sel:consume:Source should only be called on a cycle where $sel:canPeek:Source is true. When implementing a Module returning a Source Interface, one might consider using the signal returned by $sel:canPeek:Source to protect the Action with a when.

Instances

Instances details

Functor Source #
Instance details Defined in Blarney.SourceSink Methods fmap :: (a -> b) -> Source a -> Source b # (<$) :: a -> Source b -> Source a #
Generic (Source t) #
Instance details Defined in Blarney.SourceSink Associated Types type Rep (Source t) :: Type -> Type # Methods from :: Source t -> Rep (Source t) x # to :: Rep (Source t) x -> Source t #
Interface t => Interface (Source t) #
Instance details Defined in Blarney.SourceSink Methods toIfc :: Source t -> (IfcTerm, IfcType) Source # fromIfc :: IfcTerm -> Source t Source #
ToSource (Source t) t #	Identity conversion from `Source` to `Source`
Instance details Defined in Blarney.SourceSink Methods toSource :: Source t -> Source t Source #
Connectable (Source t) (Sink t) #	`Connectable` instance for `Source` `t` and `Sink` `t`
Instance details Defined in Blarney.SourceSink Methods makeConnection :: Source t -> Sink t -> Module () Source #
ToSP (SP t0 t1) t0 t1 #	ToSP instance for StreamProcessor itself
Instance details Defined in Blarney.Stream Methods toSP :: SP t0 t1 -> SP t0 t1 Source #
ToSP (Sink t0, Source t1) t0 t1 #	ToSP instance for (Sink, Source) pairs
Instance details Defined in Blarney.Stream Methods toSP :: (Sink t0, Source t1) -> SP t0 t1 Source #
type Rep (Source t) #
Instance details Defined in Blarney.SourceSink type Rep (Source t) = D1 ('MetaData "Source" "Blarney.SourceSink" "blarney-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Source" 'PrefixI 'True) (S1 ('MetaSel ('Just "canPeek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Bit 1)) :: (S1 ('MetaSel ('Just "peek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 t) :: S1 ('MetaSel ('Just "consume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Action ())))))

toStream :: ToSource a b => a -> Stream b Source #

Convert to a Stream

nullStream :: Bits a => Stream a Source #

Null stream

guardStream :: (a -> Bit 1) -> Stream a -> Stream a Source #

Apply a guard to a stream

type SP t0 t1 = Stream t0 -> Module (Stream t1) Source #

StreamProcessor type

class ToSP a t0 t1 | a -> t0 t1 where Source #

Convert to a StreamProcessor

Methods

toSP :: a -> SP t0 t1 Source #

Instances

Instances details

ToSP (Queue a) a a #	ToSP instance for Queue
Instance details Defined in Blarney.Queue Methods toSP :: Queue a -> SP a a Source #
ToSP (SP t0 t1) t0 t1 #	ToSP instance for StreamProcessor itself
Instance details Defined in Blarney.Stream Methods toSP :: SP t0 t1 -> SP t0 t1 Source #
ToSP (Sink t0, Source t1) t0 t1 #	ToSP instance for (Sink, Source) pairs
Instance details Defined in Blarney.Stream Methods toSP :: (Sink t0, Source t1) -> SP t0 t1 Source #