Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.FS.CRC

Contents

Wrap digest functionality
File system functions with CRC functionality

Description

Support for CRC

Synopsis

newtype CRC = CRC {
- getCRC :: Word32
}
computeCRC :: forall a. CRC32 a => a -> CRC
initCRC :: CRC
updateCRC :: forall a. CRC32 a => a -> CRC -> CRC
hGetAllAtCRC :: forall m h. Monad m => HasFS m h -> Handle h -> AbsOffset -> m ( ByteString , CRC )
hGetExactlyAtCRC :: forall m h. ( HasCallStack , MonadThrow m) => HasFS m h -> Handle h -> Word64 -> AbsOffset -> m ( ByteString , CRC )
hPutAllCRC :: forall m h. ( HasCallStack , Monad m) => HasFS m h -> Handle h -> ByteString -> m ( Word64 , CRC )

Wrap digest functionality

newtype CRC Source #

Constructors

CRC
Fields getCRC :: Word32

Instances

Instances details

Eq CRC Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.CRC Methods (==) :: CRC -> CRC -> Bool Source # (/=) :: CRC -> CRC -> Bool Source #
Show CRC Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.CRC Methods showsPrec :: Int -> CRC -> ShowS Source # show :: CRC -> String Source # showList :: [ CRC ] -> ShowS Source #
Generic CRC Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.CRC Associated Types type Rep CRC :: Type -> Type Source # Methods from :: CRC -> Rep CRC x Source # to :: Rep CRC x -> CRC Source #
Storable CRC Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.CRC Methods sizeOf :: CRC -> Int Source # alignment :: CRC -> Int Source # peekElemOff :: Ptr CRC -> Int -> IO CRC Source # pokeElemOff :: Ptr CRC -> Int -> CRC -> IO () Source # peekByteOff :: Ptr b -> Int -> IO CRC Source # pokeByteOff :: Ptr b -> Int -> CRC -> IO () Source # peek :: Ptr CRC -> IO CRC Source # poke :: Ptr CRC -> CRC -> IO () Source #
NoThunks CRC Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.CRC Methods noThunks :: Context -> CRC -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> CRC -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy CRC -> String Source #
type Rep CRC Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.CRC type Rep CRC = D1 (' MetaData "CRC" "Ouroboros.Consensus.Storage.FS.CRC" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' True ) ( C1 (' MetaCons "CRC" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getCRC") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word32 )))

computeCRC :: forall a. CRC32 a => a -> CRC Source #

initCRC :: CRC Source #

updateCRC :: forall a. CRC32 a => a -> CRC -> CRC Source #

File system functions with CRC functionality

hGetAllAtCRC Source #

Arguments

:: forall m h. Monad m
=> HasFS m h
-> Handle h
-> AbsOffset	The offset at which to read.
-> m ( ByteString , CRC )

Variation on hGetAllAt that also computes a CRC

hGetExactlyAtCRC Source #

Arguments

:: forall m h. ( HasCallStack , MonadThrow m)
=> HasFS m h
-> Handle h
-> Word64	The number of bytes to read.
-> AbsOffset	The offset at which to read.
-> m ( ByteString , CRC )

Variation on hGetExactlyAt that also computes a CRC

hPutAllCRC :: forall m h. ( HasCallStack , Monad m) => HasFS m h -> Handle h -> ByteString -> m ( Word64 , CRC ) Source #

Variation on hPutAll that also computes a CRC