Crypto.Lol.Types.Proto

Convenient interfaces for serialization with protocol buffers.

Documentation

class Protoable a where

Conversion between Haskell types and their protocol buffer representations.

Minimal complete definition

toProto, fromProto

Associated Types

type ProtoType a

Methods

toProto :: a -> ProtoType a

Convert from a type to its protocol buffer representation.

fromProto :: MonadError String m => ProtoType a -> m a

Convert from a protocol buffer representation.

Instances

Protoable Fingerprint

Associated Types

type ProtoType Fingerprint :: *

Methods

toProto :: Fingerprint -> ProtoType Fingerprint

fromProto :: MonadError String m => ProtoType Fingerprint -> m Fingerprint

Protoable a => Protoable [a]

Associated Types

type ProtoType [a] :: *

Methods

toProto :: [a] -> ProtoType [a]

fromProto :: MonadError String m => ProtoType [a] -> m [a]

(Protoable a, Protoable b) => Protoable (a, b)

Associated Types

type ProtoType (a, b) :: *

Methods

toProto :: (a, b) -> ProtoType (a, b)

fromProto :: MonadError String m => ProtoType (a, b) -> m (a, b)

(Protoable (IZipVector m (RRq k q Double)), (~) * (ProtoType (IZipVector m (RRq k q Double))) KqProduct, Protoable (IZipVector m b), (~) * (ProtoType (IZipVector m b)) KqProduct) => Protoable (IZipVector m (RRq k q Double, b))

Associated Types

type ProtoType (IZipVector m (RRq k q Double, b)) :: *

Methods

toProto :: IZipVector m (RRq k q Double, b) -> ProtoType (IZipVector m (RRq k q Double, b))

fromProto :: MonadError String m => ProtoType (IZipVector m (RRq k q Double, b)) -> m (IZipVector m (RRq k q Double, b))

(Protoable (IZipVector m (ZqBasic k q Int64)), (~) * (ProtoType (IZipVector m (ZqBasic k q Int64))) RqProduct, Protoable (IZipVector m b), (~) * (ProtoType (IZipVector m b)) RqProduct) => Protoable (IZipVector m (ZqBasic k q Int64, b))

Associated Types

type ProtoType (IZipVector m (ZqBasic k q Int64, b)) :: *

Methods

toProto :: IZipVector m (ZqBasic k q Int64, b) -> ProtoType (IZipVector m (ZqBasic k q Int64, b))

fromProto :: MonadError String m => ProtoType (IZipVector m (ZqBasic k q Int64, b)) -> m (IZipVector m (ZqBasic k q Int64, b))

(Fact m, Reflects k q Double) => Protoable (IZipVector m (RRq k q Double))

Associated Types

type ProtoType (IZipVector m (RRq k q Double)) :: *

Methods

toProto :: IZipVector m (RRq k q Double) -> ProtoType (IZipVector m (RRq k q Double))

fromProto :: MonadError String m => ProtoType (IZipVector m (RRq k q Double)) -> m (IZipVector m (RRq k q Double))

(Fact m, Reflects k q Int64) => Protoable (IZipVector m (ZqBasic k q Int64))

Associated Types

type ProtoType (IZipVector m (ZqBasic k q Int64)) :: *

Methods

toProto :: IZipVector m (ZqBasic k q Int64) -> ProtoType (IZipVector m (ZqBasic k q Int64))

fromProto :: MonadError String m => ProtoType (IZipVector m (ZqBasic k q Int64)) -> m (IZipVector m (ZqBasic k q Int64))

Fact m => Protoable (IZipVector m Int64)

Associated Types

type ProtoType (IZipVector m Int64) :: *

Methods

toProto :: IZipVector m Int64 -> ProtoType (IZipVector m Int64)

fromProto :: MonadError String m => ProtoType (IZipVector m Int64) -> m (IZipVector m Int64)

(Fact m, CElt t r, Protoable (UCyc t m D r)) => Protoable (Cyc t m r)

Associated Types

type ProtoType (Cyc t m r) :: *

Methods

toProto :: Cyc t m r -> ProtoType (Cyc t m r)

fromProto :: MonadError String m => ProtoType (Cyc t m r) -> m (Cyc t m r)

Protoable (t m r) => Protoable (UCyc t m D r)

Associated Types

type ProtoType (UCyc t m D r) :: *

Methods

toProto :: UCyc t m D r -> ProtoType (UCyc t m D r)

fromProto :: MonadError String m => ProtoType (UCyc t m D r) -> m (UCyc t m D r)

(Reflects Factored e Word32, Reflects Factored r Word32, Protoable (Cyc t s zq), (~) * (ProtoType (t s zq)) RqProduct) => Protoable (Linear t zq e r s)

Associated Types

type ProtoType (Linear t zq e r s) :: *

Methods

toProto :: Linear t zq e r s -> ProtoType (Linear t zq e r s)

fromProto :: MonadError String m => ProtoType (Linear t zq e r s) -> m (Linear t zq e r s)

msgPut :: (ReflectDescriptor (ProtoType a), Wire (ProtoType a), Protoable a) => a -> ByteString

Serialize a Haskell type to its protocol buffer ByteString.

msgGet :: (ReflectDescriptor (ProtoType a), Wire (ProtoType a), Protoable a) => ByteString -> Either String (a, ByteString)

Read a protocol buffer ByteString to a Haskell type.

uToString :: Utf8 -> String

uFromString :: String -> Utf8

readProtoType :: (ReflectDescriptor a, Wire a, MonadIO m, MonadError String m) => FilePath -> m a

Read a serialized protobuffer from a file.

parseProtoFile :: (ProtoReadable a, MonadIO m, MonadError String m) => FilePath -> m a

Read a protocol buffer stream at the given path and convert it to typed Haskell data.

writeProtoType :: (ReflectDescriptor a, Wire a) => FilePath -> a -> IO ()

Writes any auto-gen'd proto object to path/filename.

writeProtoFile :: (ProtoReadable a, MonadIO m) => FilePath -> a -> m ()

Write a protocol buffer stream for Haskell data to the given path.

type ProtoReadable a = (Protoable a, Wire (ProtoType a), ReflectDescriptor (ProtoType a))

Constraint synonym for end-to-end readingparsingwriting of Protoable types.