Data.Conduit.Parsers.PutS

This module provides the PutS functor, and all functions, which could not be defined using PutS public interface only.

Documentation

class EncodingState s where

Collects encoding process feedback.

Minimal complete definition

encoded

Associated Types

type EncodingToken s :: *

Methods

encoded :: EncodingToken s -> s -> s

Instances

EncodingState VoidEncodingState

Associated Types

type EncodingToken VoidEncodingState :: *

Methods

encoded :: EncodingToken VoidEncodingState -> VoidEncodingState -> VoidEncodingState

EncodingState ByteOffset

Associated Types

type EncodingToken ByteOffset :: *

Methods

encoded :: EncodingToken ByteOffset -> ByteOffset -> ByteOffset

(EncodingState s, Monad m) => EncodingState (Encoding s m)

Associated Types

type EncodingToken (Encoding s m) :: *

Methods

encoded :: EncodingToken (Encoding s m) -> Encoding s m -> Encoding s m

data VoidEncodingState

Trivial encoding state.

Constructors

VoidEncodingState

Instances

EncodingState VoidEncodingState

Associated Types

type EncodingToken VoidEncodingState :: *

Methods

encoded :: EncodingToken VoidEncodingState -> VoidEncodingState -> VoidEncodingState

type EncodingToken VoidEncodingState

type EncodingToken VoidEncodingState = ()

data Encoding s m

PutS monad state.

Instances

(EncodingState s, Monad m) => EncodingState (Encoding s m)

Associated Types

type EncodingToken (Encoding s m) :: *

Methods

encoded :: EncodingToken (Encoding s m) -> Encoding s m -> Encoding s m

EncodingBytesWrote s => EncodingBytesWrote (Encoding s m)

Methods

encodingBytesWrote :: Encoding s m -> Word64

type EncodingToken (Encoding s m)

type EncodingToken (Encoding s m) = (m (), EncodingToken s)

encodingWrote :: Encoding s m -> s

Get the total number of bytes wrote to this point.

runEncoding :: Encoding s m -> m ()

Get the Producer.

startEncoding :: Applicative m => s -> Encoding s m

Construct PutS initial state.

data PutS s m a

Wrappers for PutM with inner monad m and result a (usually ()).

Instances

Monad (PutS s m)

Methods

(>>=) :: PutS s m a -> (a -> PutS s m b) -> PutS s m b

(>>) :: PutS s m a -> PutS s m b -> PutS s m b

return :: a -> PutS s m a

fail :: String -> PutS s m a

Functor (PutS s m)

Methods

fmap :: (a -> b) -> PutS s m a -> PutS s m b

(<$) :: a -> PutS s m b -> PutS s m a

MonadFix (PutS s m)

Methods

mfix :: (a -> PutS s m a) -> PutS s m a

Applicative (PutS s m)

Methods

pure :: a -> PutS s m a

(<*>) :: PutS s m (a -> b) -> PutS s m a -> PutS s m b

liftA2 :: (a -> b -> c) -> PutS s m a -> PutS s m b -> PutS s m c

(*>) :: PutS s m a -> PutS s m b -> PutS s m b

(<*) :: PutS s m a -> PutS s m b -> PutS s m a

Monad m => Semigroup (PutS s m ())

Methods

(<>) :: PutS s m () -> PutS s m () -> PutS s m ()

sconcat :: NonEmpty (PutS s m ()) -> PutS s m ()

stimes :: Integral b => b -> PutS s m () -> PutS s m ()

(EncodingState s, (~) * (EncodingToken s) (), Monad m) => IsString (PutM s i Text m ())

Methods

fromString :: String -> PutM s i Text m ()

runPutS :: PutS s m a -> Encoding s m -> (a, Encoding s m)

Run a Put monad, unwrapping all wrappers in a reversible way. putS . runPutS = id

putS :: (Encoding s m -> (a, Encoding s m)) -> PutS s m a

Custom Put. putS . runPutS = id

type PutM s i o m a = PutS s (ConduitM i o m) a

A ConduitM with wrappers supposed to a binary serialization.