Safe Haskell	None
Language	Haskell2010

Cardano.Crypto.PinnedSizedBytes

Contents

Initialization
Conversions
C usage

Synopsis

data PinnedSizedBytes (n :: Nat)
psbZero :: KnownNat n => PinnedSizedBytes n
psbFromBytes :: forall n. KnownNat n => [Word8] -> PinnedSizedBytes n
psbToBytes :: PinnedSizedBytes n -> [Word8]
psbFromByteString :: KnownNat n => ByteString -> PinnedSizedBytes n
psbFromByteStringCheck :: forall n. KnownNat n => ByteString -> Maybe (PinnedSizedBytes n)
psbToByteString :: PinnedSizedBytes n -> ByteString
psbUseAsCPtr :: PinnedSizedBytes n -> (Ptr Word8 -> IO r) -> IO r
psbUseAsSizedPtr :: PinnedSizedBytes n -> (SizedPtr n -> IO r) -> IO r
psbCreate :: forall n. KnownNat n => (Ptr Word8 -> IO ()) -> IO (PinnedSizedBytes n)
psbCreateSized :: forall n. KnownNat n => (SizedPtr n -> IO ()) -> IO (PinnedSizedBytes n)
ptrPsbToSizedPtr :: Ptr (PinnedSizedBytes n) -> SizedPtr n

Documentation

data PinnedSizedBytes (n :: Nat) Source #

n bytes. Storable.

We have two *Bytes types:

PinnedSizedBytes is backed by pinned ByteArray.
MLockedSizedBytes is backed by ForeignPtr to mlock-ed memory region.

The ByteString is pinned datatype, but it's represented by ForeignPtr + offset (and size).

I'm sorry for adding more types for bytes. :(

Instances

Instances details

KnownNat n => Eq (PinnedSizedBytes n) Source #	The comparison is done in constant time for a given size `n`.
Instance details Defined in Cardano.Crypto.PinnedSizedBytes Methods (==) :: PinnedSizedBytes n -> PinnedSizedBytes n -> Bool # (/=) :: PinnedSizedBytes n -> PinnedSizedBytes n -> Bool #
KnownNat n => Ord (PinnedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.PinnedSizedBytes Methods compare :: PinnedSizedBytes n -> PinnedSizedBytes n -> Ordering # (<) :: PinnedSizedBytes n -> PinnedSizedBytes n -> Bool # (<=) :: PinnedSizedBytes n -> PinnedSizedBytes n -> Bool # (>) :: PinnedSizedBytes n -> PinnedSizedBytes n -> Bool # (>=) :: PinnedSizedBytes n -> PinnedSizedBytes n -> Bool # max :: PinnedSizedBytes n -> PinnedSizedBytes n -> PinnedSizedBytes n # min :: PinnedSizedBytes n -> PinnedSizedBytes n -> PinnedSizedBytes n #
Show (PinnedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.PinnedSizedBytes Methods showsPrec :: Int -> PinnedSizedBytes n -> ShowS # show :: PinnedSizedBytes n -> String # showList :: [PinnedSizedBytes n] -> ShowS #
KnownNat n => IsString (PinnedSizedBytes n) Source #	If given `String` is too long, it is truncated, If it is too short, it is padded with zeros. Padding and truncation make it behave like an integer mod `n8`. `>>>` `"abcdef" :: PinnedSizedBytes 4`"63646566" `>>>` `"foo" :: PinnedSizedBytes 8`"0000000000666f6f" Non-ASCII codepoints are silently truncated to 0..255 range. `>>>` `"\x1234\x5678" :: PinnedSizedBytes 2`"3478" `PinnedSizedBytes` created with `fromString` contains unpinned* `ByteArray`.
Instance details Defined in Cardano.Crypto.PinnedSizedBytes Methods fromString :: String -> PinnedSizedBytes n #
KnownNat n => Storable (PinnedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.PinnedSizedBytes Methods sizeOf :: PinnedSizedBytes n -> Int # alignment :: PinnedSizedBytes n -> Int # peekElemOff :: Ptr (PinnedSizedBytes n) -> Int -> IO (PinnedSizedBytes n) # pokeElemOff :: Ptr (PinnedSizedBytes n) -> Int -> PinnedSizedBytes n -> IO () # peekByteOff :: Ptr b -> Int -> IO (PinnedSizedBytes n) # pokeByteOff :: Ptr b -> Int -> PinnedSizedBytes n -> IO () # peek :: Ptr (PinnedSizedBytes n) -> IO (PinnedSizedBytes n) # poke :: Ptr (PinnedSizedBytes n) -> PinnedSizedBytes n -> IO () #
NFData (PinnedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.PinnedSizedBytes Methods rnf :: PinnedSizedBytes n -> () #
NoThunks (PinnedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.PinnedSizedBytes Methods noThunks :: Context -> PinnedSizedBytes n -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> PinnedSizedBytes n -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (PinnedSizedBytes n) -> String Source #

Initialization

psbZero :: KnownNat n => PinnedSizedBytes n Source #

Conversions

psbFromBytes :: forall n. KnownNat n => [Word8] -> PinnedSizedBytes n Source #

See IsString (PinnedSizedBytes n) instance.

>>> psbToBytes . (id @(PinnedSizedBytes 4)) . psbFromBytes $ [1,2,3,4]
[1,2,3,4]

>>> psbToBytes . (id @(PinnedSizedBytes 4)) . psbFromBytes $ [1,2]
[0,0,1,2]

>>> psbToBytes . (id @(PinnedSizedBytes 4)) . psbFromBytes $ [1,2,3,4,5,6]
[3,4,5,6]

psbToBytes :: PinnedSizedBytes n -> [Word8] Source #

See psbFromBytes.

psbFromByteString :: KnownNat n => ByteString -> PinnedSizedBytes n Source #

psbFromByteStringCheck :: forall n. KnownNat n => ByteString -> Maybe (PinnedSizedBytes n) Source #

psbToByteString :: PinnedSizedBytes n -> ByteString Source #

C usage

psbUseAsCPtr :: PinnedSizedBytes n -> (Ptr Word8 -> IO r) -> IO r Source #

psbUseAsSizedPtr :: PinnedSizedBytes n -> (SizedPtr n -> IO r) -> IO r Source #

psbCreate :: forall n. KnownNat n => (Ptr Word8 -> IO ()) -> IO (PinnedSizedBytes n) Source #

psbCreateSized :: forall n. KnownNat n => (SizedPtr n -> IO ()) -> IO (PinnedSizedBytes n) Source #

ptrPsbToSizedPtr :: Ptr (PinnedSizedBytes n) -> SizedPtr n Source #