Capnp.IO

This module provides utilities for reading and writing values to and from file Handles.

Documentation

hGetValue :: FromStruct 'Const a => Handle -> WordCount -> IO a

hGetValue limit handle reads a message from handle, returning its root object. limit is used as both a cap on the size of a message which may be read and, for types in the high-level API, the traversal limit when decoding the message.

It may throw a Error if there is a problem decoding the message, or an IOError raised by the underlying IO libraries.

getValue :: FromStruct 'Const a => WordCount -> IO a

getValue is equivalent to hGetValue stdin.

sGetMsg :: Socket -> WordCount -> IO (Message 'Const)

Like hGetMsg, except that it takes a socket instead of a Handle.

sGetValue :: FromStruct 'Const a => Socket -> WordCount -> IO a

Like hGetValue, except that it takes a socket instead of a Handle.

hPutValue :: (Cerialize RealWorld a, ToStruct ('Mut RealWorld) (Cerial ('Mut RealWorld) a)) => Handle -> a -> IO ()

hPutValue handle value writes value to handle, as the root object of a message. If it throws an exception, it will be an IOError raised by the underlying IO libraries.

putValue :: (Cerialize RealWorld a, ToStruct ('Mut RealWorld) (Cerial ('Mut RealWorld) a)) => a -> IO ()

putValue is equivalent to hPutValue stdin

sPutValue :: (Cerialize RealWorld a, ToStruct ('Mut RealWorld) (Cerial ('Mut RealWorld) a)) => Socket -> a -> IO ()

Like hPutValue, except that it takes a Socket instead of a Handle.

sPutMsg :: Socket -> Message 'Const -> IO ()

Like hPutMsg, except that it takes a Socket instead of a Handle.

hGetMsg :: Handle -> WordCount -> IO (Message 'Const)

hGetMsg handle limit reads a message from handle that is at most limit 64-bit words in length.

getMsg :: WordCount -> IO (Message 'Const)

Equivalent to hGetMsg stdin

hPutMsg :: Handle -> Message 'Const -> IO ()

hPutMsg handle msg writes msg to handle. If there is an exception, it will be an IOError raised by the underlying IO libraries.

putMsg :: Message 'Const -> IO ()

Equivalent to hPutMsg stdout

hGetParsed :: forall a pa. (IsStruct a, Parse a pa) => Handle -> WordCount -> IO pa

Read a struct from the handle in its parsed form, using the supplied read limit.

sGetParsed :: forall a pa. (IsStruct a, Parse a pa) => Socket -> WordCount -> IO pa

Read a struct from the socket in its parsed form, using the supplied read limit.

getParsed :: (IsStruct a, Parse a pa) => WordCount -> IO pa

Read a struct from stdin in its parsed form, using the supplied read limit.

hPutParsed :: (IsStruct a, Parse a pa) => Handle -> pa -> IO ()

Write the parsed form of a struct to the handle

sPutParsed :: (IsStruct a, Parse a pa) => Socket -> pa -> IO ()

Write the parsed form of a struct to the socket.

putParsed :: (IsStruct a, Parse a pa) => pa -> IO ()

Write the parsed form of a struct to stdout

hGetRaw :: IsStruct a => Handle -> WordCount -> IO (Raw 'Const a)

Read a struct from the handle using the supplied read limit, and return its root pointer.

getRaw :: IsStruct a => WordCount -> IO (Raw 'Const a)

Read a struct from stdin using the supplied read limit, and return its root pointer.

sGetRaw :: IsStruct a => Socket -> WordCount -> IO (Raw 'Const a)

Read a struct from the socket using the supplied read limit, and return its root pointer.