Module

Node.Stream.Object

Package: purescript-node-stream-pipes
Repository: cakekindel/purescript-node-stream-pipes

#ReadResult Source

data ReadResult a

Constructors

ReadWouldBlock
ReadJust a

Instances

#maybeReadResult Source

maybeReadResult :: forall a. ReadResult a -> Maybe a

#WriteResult Source

data WriteResult

Constructors

WriteWouldBlock
WriteOk

Instances

#ReadResultFFI Source

type ReadResultFFI a = { just :: a -> ReadResult a, wouldBlock :: ReadResult a }

#WriteResultFFI Source

type WriteResultFFI = { ok :: WriteResult, wouldBlock :: WriteResult }

#Writable Source

data Writable t0

Instances

Stream (Writable a)
Write (Writable a) a

#Readable Source

data Readable t0

Instances

Stream (Readable a)
Read (Readable a) a

#Transform Source

data Transform t0 t1

Instances

Stream (Transform a b)
Read (Transform a b) b
Write (Transform a b) a

#endImpl Source

endImpl :: forall s. s -> Effect Unit

#writeImpl Source

writeImpl :: forall s a. WriteResultFFI -> s -> a -> Effect WriteResult

#readImpl Source

readImpl :: forall s a. ReadResultFFI a -> s -> Effect (ReadResult a)

#isReadableImpl Source

isReadableImpl :: forall s. s -> Effect Boolean

#isWritableImpl Source

isWritableImpl :: forall s. s -> Effect Boolean

#isReadableEndedImpl Source

isReadableEndedImpl :: forall s. s -> Effect Boolean

#isWritableEndedImpl Source

isWritableEndedImpl :: forall s. s -> Effect Boolean

#isClosedImpl Source

isClosedImpl :: forall s. s -> Effect Boolean

#needsDrainImpl Source

needsDrainImpl :: forall s. s -> Effect Boolean

#readableLengthImpl Source

readableLengthImpl :: forall s. s -> Effect Int

#readResultFFI Source

readResultFFI :: forall a. ReadResultFFI a

#writeResultFFI Source

writeResultFFI :: WriteResultFFI

#Stream Source

class Stream s  where

Members

isClosed :: s -> Effect Boolean

Instances

Stream (Readable a)
Stream (Writable a)
Stream (Transform a b)
(Stream s) => Stream s

#Read Source

class (Stream s) <= Read s a | s -> a where

Members

readableLength :: s -> Effect Int
isReadable :: s -> Effect Boolean
isReadableEnded :: s -> Effect Boolean
read :: s -> Effect (ReadResult a)

Instances

Read (Readable a) a
Read (Transform a b) b
(Read s a) => Read s a

#Write Source

class (Stream s) <= Write s a | s -> a where

Members

isWritable :: s -> Effect Boolean
needsDrain :: s -> Effect Boolean
isWritableEnded :: s -> Effect Boolean
write :: s -> a -> Effect WriteResult
end :: s -> Effect Unit

Instances

Write (Writable a) a
Write (Transform a b) a
(Write s a) => Write s a

#withErrorST Source

withErrorST :: forall s. Stream s => s -> Effect { cancel :: Effect Unit, error :: STRef Global (Maybe Error) }

#unsafeCoerceWritable Source

unsafeCoerceWritable :: forall r a. Writable r -> Writable a

#unsafeCoerceReadable Source

unsafeCoerceReadable :: forall r a. Readable r -> Readable a

#unsafeCoerceTransform Source

unsafeCoerceTransform :: forall a b. Duplex -> Transform a b

#unsafeFromBufferReadable Source

unsafeFromBufferReadable :: forall r. Readable r -> Readable Buffer

#unsafeFromBufferTransform Source

unsafeFromBufferTransform :: forall a. Duplex -> Transform Buffer a

#unsafeFromBufferWritable Source

unsafeFromBufferWritable :: forall r. Writable r -> Writable Buffer

#unsafeFromStringReadable Source

unsafeFromStringReadable :: forall r. Readable r -> Readable String

#unsafeFromStringTransform Source

unsafeFromStringTransform :: forall a. Duplex -> Transform String a

#unsafeFromStringWritable Source

unsafeFromStringWritable :: forall r. Writable r -> Writable String

#awaitReadableOrClosed Source

awaitReadableOrClosed :: forall s a. Read s a => s -> Aff Unit

#awaitFinished Source

awaitFinished :: forall s a. Write s a => s -> Aff Unit

#awaitWritableOrClosed Source

awaitWritableOrClosed :: forall s a. Write s a => s -> Aff Unit

#onceAff0 Source

onceAff0 :: forall e. EventHandle0 e -> e -> Aff Unit

#onceAff1 Source

onceAff1 :: forall e a. EventHandle1 e a -> e -> Aff a

#readableH Source

readableH :: forall s a. Read s a => EventHandle0 s

#drainH Source

drainH :: forall s a. Write s a => EventHandle0 s

#closeH Source

closeH :: forall s. Stream s => EventHandle0 s

#errorH Source

errorH :: forall s. Stream s => EventHandle1 s Error

#endH Source

endH :: forall s a. Write s a => EventHandle0 s

#finishH Source

finishH :: forall s a. Write s a => EventHandle0 s

Modules: Node.Stream.Object; Pipes.Collect; Pipes.Construct; Pipes.Node.Buffer; Pipes.Node.FS; Pipes.Node.Stream; Pipes.Node.Zlib; Pipes.String; Pipes.Util