Pantry.SHA256

Provides a data type (SHA256) for efficient memory representation of a sha-256 hash value, together with helper functions for converting to and from that value. This module is intended to be imported qualified as SHA256.

Some nomenclature:

• Hashing calculates a new hash value from some input. from takes a value that represents an existing hash.
• Raw means a raw binary representation of the hash value, without any hex encoding.
• Text always uses lower case hex encoding

Since: 0.1.0.0

Types

data SHA256

A SHA256 hash, stored in a static size for more efficient memory representation.

Since: 0.1.0.0

Instances

FromJSON SHA256

Defined in Pantry.SHA256

Methods

parseJSON :: Value -> Parser SHA256

parseJSONList :: Value -> Parser [SHA256]

ToJSON SHA256

Defined in Pantry.SHA256

Methods

toJSON :: SHA256 -> Value

toEncoding :: SHA256 -> Encoding

toJSONList :: [SHA256] -> Value

toEncodingList :: [SHA256] -> Encoding

Data SHA256

Defined in Pantry.SHA256

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SHA256 -> c SHA256

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SHA256

toConstr :: SHA256 -> Constr

dataTypeOf :: SHA256 -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SHA256)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SHA256)

gmapT :: (forall b. Data b => b -> b) -> SHA256 -> SHA256

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SHA256 -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SHA256 -> r

gmapQ :: (forall d. Data d => d -> u) -> SHA256 -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SHA256 -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SHA256 -> m SHA256

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SHA256 -> m SHA256

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SHA256 -> m SHA256

Generic SHA256

Defined in Pantry.SHA256

Associated Types

type Rep SHA256 :: Type -> Type

Methods

from :: SHA256 -> Rep SHA256 x

to :: Rep SHA256 x -> SHA256

Show SHA256

Defined in Pantry.SHA256

Methods

showsPrec :: Int -> SHA256 -> ShowS

show :: SHA256 -> String

showList :: [SHA256] -> ShowS

NFData SHA256

Defined in Pantry.SHA256

Methods

rnf :: SHA256 -> ()

Eq SHA256

Defined in Pantry.SHA256

Methods

(==) :: SHA256 -> SHA256 -> Bool

(/=) :: SHA256 -> SHA256 -> Bool

Ord SHA256

Defined in Pantry.SHA256

Methods

compare :: SHA256 -> SHA256 -> Ordering

(<) :: SHA256 -> SHA256 -> Bool

(<=) :: SHA256 -> SHA256 -> Bool

(>) :: SHA256 -> SHA256 -> Bool

(>=) :: SHA256 -> SHA256 -> Bool

max :: SHA256 -> SHA256 -> SHA256

min :: SHA256 -> SHA256 -> SHA256

Hashable SHA256

Defined in Pantry.SHA256

Methods

hashWithSalt :: Int -> SHA256 -> Int

hash :: SHA256 -> Int

PersistField SHA256

Defined in Pantry.SHA256

Methods

toPersistValue :: SHA256 -> PersistValue

fromPersistValue :: PersistValue -> Either Text SHA256

PersistFieldSql SHA256

Defined in Pantry.SHA256

Methods

sqlType :: Proxy SHA256 -> SqlType

Display SHA256

Defined in Pantry.SHA256

Methods

display :: SHA256 -> Utf8Builder

textDisplay :: SHA256 -> Text

type Rep SHA256

Defined in Pantry.SHA256

type Rep SHA256 = D1 ('MetaData "SHA256" "Pantry.SHA256" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'True) (C1 ('MetaCons "SHA256" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bytes32)))

data SHA256Exception

Exceptions which can occur in this module

Since: 0.1.0.0

Constructors

InvalidByteCount !ByteString !StaticBytesException

InvalidHexBytes !ByteString !Text

Instances

Exception SHA256Exception

Defined in Pantry.SHA256

Methods

toException :: SHA256Exception -> SomeException

fromException :: SomeException -> Maybe SHA256Exception

displayException :: SHA256Exception -> String

Show SHA256Exception

Defined in Pantry.SHA256

Methods

showsPrec :: Int -> SHA256Exception -> ShowS

show :: SHA256Exception -> String

showList :: [SHA256Exception] -> ShowS

Display SHA256Exception

Defined in Pantry.SHA256

Methods

display :: SHA256Exception -> Utf8Builder

textDisplay :: SHA256Exception -> Text

Hashing

hashFile :: MonadIO m => FilePath -> m SHA256

Generate a SHA256 value by hashing the contents of a file.

Since: 0.1.0.0

hashBytes :: ByteString -> SHA256

Generate a SHA256 value by hashing a ByteString.

Since: 0.1.0.0

hashLazyBytes :: LByteString -> SHA256

Generate a SHA256 value by hashing a lazy ByteString.

Since: 0.1.0.0

sinkHash :: Monad m => ConduitT ByteString o m SHA256

Generate a SHA256 value by hashing the contents of a stream.

Since: 0.1.0.0

Convert from a hash representation

fromHexText :: Text -> Either SHA256Exception SHA256

Convert a base16-encoded Text value containing a hash into a SHA256.

Since: 0.1.0.0

fromHexBytes :: ByteString -> Either SHA256Exception SHA256

Convert a base16-encoded ByteString value containing a hash into a SHA256.

Since: 0.1.0.0

fromDigest :: Digest SHA256 -> SHA256

Convert a Digest into a SHA256

Since: 0.1.0.0

fromRaw :: ByteString -> Either SHA256Exception SHA256

Convert a raw representation of a hash into a SHA256.

Since: 0.1.0.0

Convert to a hash representation

toHexText :: SHA256 -> Text

Convert a SHA256 into a base16-encoded SHA256 hash.

Since: 0.1.0.0

toHexBytes :: SHA256 -> ByteString

Convert a SHA256 into a base16-encoded SHA256 hash.

Since: 0.1.0.0

toRaw :: SHA256 -> ByteString

Convert a SHA256 into a raw binary representation.

Since: 0.1.0.0