Skip to content

HORIZON HASKELL Docs lts/ghc-9.14.x6d5fdfd2026-10-12Search packagesCtrl K

Theme: |

GHC 9.14.1 · lts/ghc-9.14.x · 6d5fdfd · 2026-10-12

Modulebrick-3.0Haskell2010

Brick.BChan

Synopsis

data BChan
value newBChan
value writeBChan
value writeBChanNonBlocking
value readBChan
value readBChan2

Packagebrick-3.0
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceBChan.hs

datadata BChan a

BChan is an abstract type representing a bounded FIFO channel.

valuenewBChan

:: Int
maximum number of elements the channel can hold
-> IO (BChan a)

Builds and returns a new instance of BChan.

valuewriteBChan :: BChan a -> a -> IO ()

Writes a value to a BChan; blocks if the channel is full.

valuewriteBChanNonBlocking :: BChan a -> a -> IO Bool

Attempts to write a value to a BChan. If the channel has room, the value is written and this returns True. Otherwise this returns False and returns immediately.

valuereadBChan :: BChan a -> IO a

Reads the next value from the BChan; blocks if necessary.

valuereadBChan2 :: BChan a -> BChan b -> IO (Either a b)

Reads the next value from either BChan, prioritizing the first BChan; blocks if necessary.