ModuleCabal-syntax-3.12.1.0Haskell2010

Distribution.Compat.Binary

7 types
3 classes
17 values

PackageCabal-syntax-3.12.1.0
Exports27
LanguageHaskell2010
LicenceBSD-3-Clause
SourceBinary.hs

valuedecodeOrFailIO :: Binary a => ByteString -> IO (Either String a)

valuedecodeFileOrFail' :: Binary a => FilePath -> IO (Either String a)

Lazily reconstruct a value previously written to a file.

classclass Binary t where

The Binary class provides put and get, methods to encode and decode a Haskell value to a lazy ByteString. It mirrors the Read and Show classes for textual representation of Haskell types, and is suitable for serialising Haskell values to disk, over the network.

For decoding and generating simple external binary formats (e.g. C structures), Binary may be used, but in general is not suitable for complex protocols. Instead use the Put and Get primitives directly.

Instances of Binary should satisfy the following property:

decode . encode == id

That is, the get and put methods should be the inverse of each other. A range of instances are provided for basic Haskell types.

Methods

put :: t -> Put
Encode a value in the Put monad.
get :: Get t
Decode a value in the Get monad
putList :: [t] -> Put
Encode a list of values in the Put monad. The default implementation may be overridden to be more efficient but must still have the same encoding format.

Instances168Binary, …

Binary OpenModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Backpack
Binary OpenUnitIdDefined in Cabal-syntax-3.12.1.0 · Distribution.Backpack
Binary CabalSpecVersionDefined in Cabal-syntax-3.12.1.0 · Distribution.CabalSpecVersion
Binary AbiTagDefined in Cabal-syntax-3.12.1.0 · Distribution.Compiler
Binary CompilerFlavorDefined in Cabal-syntax-3.12.1.0 · Distribution.Compiler
Binary CompilerIdDefined in Cabal-syntax-3.12.1.0 · Distribution.Compiler
Binary CompilerInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Compiler
Binary LicenseDefined in Cabal-syntax-3.12.1.0 · Distribution.License
Binary ModuleNameDefined in Cabal-syntax-3.12.1.0 · Distribution.ModuleName
Binary PErrorDefined in Cabal-syntax-3.12.1.0 · Distribution.Parsec.Error
Binary PositionDefined in Cabal-syntax-3.12.1.0 · Distribution.Parsec.Position
Binary PWarnTypeDefined in Cabal-syntax-3.12.1.0 · Distribution.Parsec.Warning
Binary PWarningDefined in Cabal-syntax-3.12.1.0 · Distribution.Parsec.Warning
Binary LicenseDefined in Cabal-syntax-3.12.1.0 · Distribution.SPDX.License
Binary LicenseExceptionIdDefined in Cabal-syntax-3.12.1.0 · Distribution.SPDX.LicenseExceptionId
Binary LicenseExpressionDefined in Cabal-syntax-3.12.1.0 · Distribution.SPDX.LicenseExpression
Binary SimpleLicenseExpressionDefined in Cabal-syntax-3.12.1.0 · Distribution.SPDX.LicenseExpression
Binary LicenseIdDefined in Cabal-syntax-3.12.1.0 · Distribution.SPDX.LicenseId
Binary LicenseRefDefined in Cabal-syntax-3.12.1.0 · Distribution.SPDX.LicenseReference
Binary ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Binary OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Binary PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Binary AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Binary AbiHashDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiHash
Binary BenchmarkDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Benchmark
Binary BenchmarkInterfaceDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.BenchmarkInterface
Binary BenchmarkTypeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.BenchmarkType
Binary BuildInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.BuildInfo
Binary BuildTypeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.BuildType
Binary ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
Binary ComponentIdDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentId
Binary ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Binary NotLibComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Binary ComponentRequestedSpecDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentRequestedSpec
Binary ConfVarDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ConfVar
Binary DependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Dependency
Binary ExeDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExeDependency
Binary ExecutableDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Executable
Binary ExecutableScopeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExecutableScope
Binary ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Binary FlagAssignmentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Flag
Binary FlagNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Flag
Binary PackageFlagDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Flag
Binary ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Binary LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Binary ForeignLibOptionDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLibOption
Binary ForeignLibTypeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLibType
Binary GenericPackageDescriptionDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.GenericPackageDescription
Binary IncludeRenamingDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.IncludeRenaming
Binary InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
Binary LegacyExeDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LegacyExeDependency
Binary LibraryDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Library
Binary LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Binary LibraryVisibilityDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryVisibility
Binary MixinDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Mixin
Binary ModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Module
Binary ModuleReexportDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ModuleReexport
Binary ModuleRenamingDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ModuleRenaming
Binary MungedPackageIdDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.MungedPackageId
Binary MungedPackageNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.MungedPackageName
Binary PackageDescriptionDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PackageDescription
Binary PackageIdentifierDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PackageId
Binary PackageNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PackageName
Binary PackageVersionConstraintDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PackageVersionConstraint
Binary PkgconfigDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PkgconfigDependency
Binary PkgconfigNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PkgconfigName
Binary PkgconfigVersionDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PkgconfigVersion
Binary PkgconfigVersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.PkgconfigVersionRange
Binary SetupBuildInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.SetupBuildInfo
Binary KnownRepoTypeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.SourceRepo
Binary RepoKindDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.SourceRepo
Binary RepoTypeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.SourceRepo
Binary SourceRepoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.SourceRepo
Binary TestSuiteDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.TestSuite
Binary TestSuiteInterfaceDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.TestSuiteInterface
Binary TestTypeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.TestType
Binary DefUnitIdDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.UnitId
Binary UnitIdDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.UnitId
Binary UnqualComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.UnqualComponentName
Binary VersionDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Version
Binary VersionRangeDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.VersionRange.Internal
Binary ShortTextDefined in Cabal-syntax-3.12.1.0 · Distribution.Utils.ShortText
Binary ExtensionDefined in Cabal-syntax-3.12.1.0 · Language.Haskell.Extension
Binary KnownExtensionDefined in Cabal-syntax-3.12.1.0 · Language.Haskell.Extension
Binary LanguageDefined in Cabal-syntax-3.12.1.0 · Language.Haskell.Extension
Binary ByteStringDefined in binary-0.8.9.3 · Data.Binary.Class
Binary ByteStringDefined in binary-0.8.9.3 · Data.Binary.Class
Binary ShortByteStringDefined in binary-0.8.9.3 · Data.Binary.Class
Binary IntSetDefined in binary-0.8.9.3 · Data.Binary.Class
Binary IntegerDefined in binary-0.8.9.3 · Data.Binary.Class
Binary NaturalDefined in binary-0.8.9.3 · Data.Binary.Class
Binary VoidDefined in binary-0.8.9.3 · Data.Binary.Class
Binary AllDefined in binary-0.8.9.3 · Data.Binary.Class
Binary AnyDefined in binary-0.8.9.3 · Data.Binary.Class
Binary SomeTypeRepDefined in binary-0.8.9.3 · Data.Binary.Class
Binary VersionDefined in binary-0.8.9.3 · Data.Binary.Class
Binary FingerprintDefined in binary-0.8.9.3 · Data.Binary.Class
Binary Int16Defined in binary-0.8.9.3 · Data.Binary.Class
Binary Int32Defined in binary-0.8.9.3 · Data.Binary.Class
Binary Int64Defined in binary-0.8.9.3 · Data.Binary.Class
Binary Int8Defined in binary-0.8.9.3 · Data.Binary.Class
Binary Word16Defined in binary-0.8.9.3 · Data.Binary.Class
Binary Word32Defined in binary-0.8.9.3 · Data.Binary.Class
Binary Word64Defined in binary-0.8.9.3 · Data.Binary.Class
Binary Word8Defined in binary-0.8.9.3 · Data.Binary.Class
Binary BoolDefined in binary-0.8.9.3 · Data.Binary.Class
Binary CharDefined in binary-0.8.9.3 · Data.Binary.Class
Binary DoubleDefined in binary-0.8.9.3 · Data.Binary.Class
Uses non-IEEE754 encoding. Does not round-trip NaN.
Binary FloatDefined in binary-0.8.9.3 · Data.Binary.Class
Uses non-IEEE754 encoding. Does not round-trip NaN.
Binary IntDefined in binary-0.8.9.3 · Data.Binary.Class
Binary KindRepDefined in binary-0.8.9.3 · Data.Binary.Class
Binary OrderingDefined in binary-0.8.9.3 · Data.Binary.Class
Binary RuntimeRepDefined in binary-0.8.9.3 · Data.Binary.Class
Binary TyConDefined in binary-0.8.9.3 · Data.Binary.Class
Binary TypeLitSortDefined in binary-0.8.9.3 · Data.Binary.Class
Binary VecCountDefined in binary-0.8.9.3 · Data.Binary.Class
Binary VecElemDefined in binary-0.8.9.3 · Data.Binary.Class
Binary WordDefined in binary-0.8.9.3 · Data.Binary.Class
Binary TextDefined in text-2.1.3 · Data.Text · orphan
Binary TextDefined in text-2.1.3 · Data.Text.Lazy · orphan
Binary ()Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (NonEmptySet a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Compat.NonEmptySet
Binary a => Binary (Last' a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Compat.Semigroup
Binary a => Binary (Option' a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Compat.Semigroup
Binary a => Binary (PerCompilerFlavor a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Compiler
Binary a => Binary (Complex a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (First a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Last a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Max a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Min a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Set a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (NonEmpty a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Identity a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (First a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Last a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Dual a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Product a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Sum a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary (Maybe a)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary a => Binary [a]Defined in binary-0.8.9.3 · Data.Binary.Class
Binary c => Binary (Condition c)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.Condition
Binary e => Binary (IntMap e)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary e => Binary (Seq e)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary e => Binary (Tree e)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary m => Binary (WrappedMonoid m)Defined in binary-0.8.9.3 · Data.Binary.Class
(IsNode a, Binary a, Show (Key a)) => Binary (Graph a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Compat.Graph
(Binary a, Integral a) => Binary (Ratio a)Defined in binary-0.8.9.3 · Data.Binary.Class
Structured a => Binary (Tag a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Utils.Structured
Binary (SymbolicPath from to)Defined in Cabal-syntax-3.12.1.0 · Distribution.Utils.Path
Binary (Fixed a)Defined in binary-0.8.9.3 · Data.Binary.Class
Typeable a => Binary (TypeRep a)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b) => Binary (Arg a b)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b) => Binary (Either a b)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b) => Binary (a, b)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary i, Ix i, Binary e) => Binary (Array i e)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary i, Ix i, Binary e, IArray UArray e) => Binary (UArray i e)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary k, Binary e) => Binary (Map k e)Defined in binary-0.8.9.3 · Data.Binary.Class
Binary (f a) => Binary (Alt f a)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b, Binary c) => Binary (a, b, c)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary v, Binary c, Binary a) => Binary (CondBranch v c a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.CondTree
(Binary v, Binary c, Binary a) => Binary (CondTree v c a)Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.CondTree
(Binary a, Binary b, Binary c, Binary d) => Binary (a, b, c, d)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b, Binary c, Binary d, Binary e) => Binary (a, b, c, d, e)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f) => Binary (a, b, c, d, e, f)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g) => Binary (a, b, c, d, e, f, g)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h) => Binary (a, b, c, d, e, f, g, h)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h, Binary i) => Binary (a, b, c, d, e, f, g, h, i)Defined in binary-0.8.9.3 · Data.Binary.Class
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h, Binary i, Binary j) => Binary (a, b, c, d, e, f, g, h, i, j)Defined in binary-0.8.9.3 · Data.Binary.Class

valuedecodeFileOrFail

:: Binary a
=> FilePath
-> IO (Either (ByteOffset, String) a)

Decode a value from a file. In case of success, the value will be returned in Right. In case of decoder errors, the error message together with the byte offset will be returned.

valuedecode :: Binary a => ByteString -> a

Decode a value from a lazy ByteString, reconstructing the original structure.

datadata Word

A Word is an unsigned integral type, with the same size as Int.

Instances33Bounded, Enum, Integral, Data, Num, Read, …

Bounded WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Enum
Enum WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Enum
Eq WordDefined in ghc-prim-0.12.0 · GHC.Classes
Integral WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Real
Data WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Data.Data
Num WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Num
Ord WordDefined in ghc-prim-0.12.0 · GHC.Classes
Read WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Read
Real WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Real
Show WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Show
Ix WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Ix
Bits WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Bits
FiniteBits WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Bits
Storable WordDefined in ghc-internal-9.1003.0 · GHC.Internal.Foreign.Storable
PrintfArg WordDefined in base-4.20.2.0 · Text.Printf
NFData WordDefined in deepseq-1.5.0.0 · Control.DeepSeq
Binary WordDefined in binary-0.8.9.3 · Data.Binary.Class
Structured WordDefined in Cabal-syntax-3.12.1.0 · Distribution.Utils.Structured
Lift WordDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
IArray UArray WordDefined in array-0.5.8.0 · Data.Array.Base
MArray IOUArray Word IODefined in array-0.5.8.0 · Data.Array.IO.Internals
Generic1 (URec Word)Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
Foldable UWordDefined in ghc-internal-9.1003.0 · GHC.Internal.Data.Foldable
Traversable UWordDefined in ghc-internal-9.1003.0 · GHC.Internal.Data.Traversable
MArray (STUArray s) Word (ST s)Defined in array-0.5.8.0 · Data.Array.Base
Functor (URec Word)Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
Eq (URec Word p)Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
Ord (URec Word p)Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
Show (URec Word p)Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
Generic (URec Word p)Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
type Rep (URec Word p) = D1 ('MetaData "URec" "GHC.Internal.Generics" "ghc-internal" 'False) (C1 ('MetaCons "UWord" 'PrefixI 'True) (S1 ('MetaSel ('Just "uWord#") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) UWord))Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
type Rep1 (URec Word) = D1 ('MetaData "URec" "GHC.Internal.Generics" "ghc-internal" 'False) (C1 ('MetaCons "UWord" 'PrefixI 'True) (S1 ('MetaSel ('Just "uWord#") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) UWord))Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
data URec Word
- UWorduWord# :: Word#
Defined in ghc-internal-9.1003.0 · GHC.Internal.Generics
Used for marking occurrences of Word#

datadata Word64

64-bit unsigned integer type

Instances23Bounded, Enum, Eq, Integral, Data, Num, …

Bounded Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Enum Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Eq Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Integral Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Data Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Data.Data
Num Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ord Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Read Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Read
Real Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Show Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ix Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Bits Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
FiniteBits Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Storable Word64Defined in ghc-internal-9.1003.0 · GHC.Internal.Foreign.Storable
PrintfArg Word64Defined in base-4.20.2.0 · Text.Printf
NFData Word64Defined in deepseq-1.5.0.0 · Control.DeepSeq
Mantissa Word64Defined in bytestring-0.12.2.0 · Data.ByteString.Builder.RealFloat.Internal
Binary Word64Defined in binary-0.8.9.3 · Data.Binary.Class
Structured Word64Defined in Cabal-syntax-3.12.1.0 · Distribution.Utils.Structured
Lift Word64Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
IArray UArray Word64Defined in array-0.5.8.0 · Data.Array.Base
MArray IOUArray Word64 IODefined in array-0.5.8.0 · Data.Array.IO.Internals
MArray (STUArray s) Word64 (ST s)Defined in array-0.5.8.0 · Data.Array.Base

datadata Word32

32-bit unsigned integer type

Instances23Bounded, Enum, Eq, Integral, Data, Num, …

Bounded Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Enum Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Eq Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Integral Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Data Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Data.Data
Num Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ord Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Read Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Read
Real Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Show Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ix Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Bits Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
FiniteBits Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Storable Word32Defined in ghc-internal-9.1003.0 · GHC.Internal.Foreign.Storable
PrintfArg Word32Defined in base-4.20.2.0 · Text.Printf
NFData Word32Defined in deepseq-1.5.0.0 · Control.DeepSeq
Mantissa Word32Defined in bytestring-0.12.2.0 · Data.ByteString.Builder.RealFloat.Internal
Binary Word32Defined in binary-0.8.9.3 · Data.Binary.Class
Structured Word32Defined in Cabal-syntax-3.12.1.0 · Distribution.Utils.Structured
Lift Word32Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
IArray UArray Word32Defined in array-0.5.8.0 · Data.Array.Base
MArray IOUArray Word32 IODefined in array-0.5.8.0 · Data.Array.IO.Internals
MArray (STUArray s) Word32 (ST s)Defined in array-0.5.8.0 · Data.Array.Base

datadata Word16

16-bit unsigned integer type

Instances22Bounded, Enum, Eq, Integral, Data, Num, …

Bounded Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Enum Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Eq Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Integral Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Data Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Data.Data
Num Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ord Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Read Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Read
Real Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Show Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ix Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Bits Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
FiniteBits Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Storable Word16Defined in ghc-internal-9.1003.0 · GHC.Internal.Foreign.Storable
PrintfArg Word16Defined in base-4.20.2.0 · Text.Printf
NFData Word16Defined in deepseq-1.5.0.0 · Control.DeepSeq
Binary Word16Defined in binary-0.8.9.3 · Data.Binary.Class
Structured Word16Defined in Cabal-syntax-3.12.1.0 · Distribution.Utils.Structured
Lift Word16Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
IArray UArray Word16Defined in array-0.5.8.0 · Data.Array.Base
MArray IOUArray Word16 IODefined in array-0.5.8.0 · Data.Array.IO.Internals
MArray (STUArray s) Word16 (ST s)Defined in array-0.5.8.0 · Data.Array.Base

datadata Word8

8-bit unsigned integer type

Instances22Bounded, Enum, Eq, Integral, Data, Num, …

Bounded Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Enum Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Eq Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Integral Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Data Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Data.Data
Num Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ord Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Read Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Read
Real Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Show Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Ix Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Bits Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
FiniteBits Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Word
Storable Word8Defined in ghc-internal-9.1003.0 · GHC.Internal.Foreign.Storable
PrintfArg Word8Defined in base-4.20.2.0 · Text.Printf
NFData Word8Defined in deepseq-1.5.0.0 · Control.DeepSeq
Binary Word8Defined in binary-0.8.9.3 · Data.Binary.Class
Structured Word8Defined in Cabal-syntax-3.12.1.0 · Distribution.Utils.Structured
Lift Word8Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
IArray UArray Word8Defined in array-0.5.8.0 · Data.Array.Base
MArray IOUArray Word8 IODefined in array-0.5.8.0 · Data.Array.IO.Internals
MArray (STUArray s) Word8 (ST s)Defined in array-0.5.8.0 · Data.Array.Base

classclass GBinaryGet (f :: k -> Type) where

Methods

gget :: Get (f t)

Instances6GBinaryGet

GBinaryGet U1Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
GBinaryGet V1Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
Binary a => GBinaryGet (K1 i a)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
(GBinaryGet a, GBinaryGet b) => GBinaryGet (a :*: b)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
(GSumGet a, GSumGet b, SumSize a, SumSize b) => GBinaryGet (a :+: b)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
GBinaryGet a => GBinaryGet (M1 i c a)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan

classclass GBinaryPut (f :: k -> Type) where

Methods

gput :: f t -> Put

Instances6GBinaryPut

GBinaryPut U1Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
GBinaryPut V1Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
Binary a => GBinaryPut (K1 i a)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
(GBinaryPut a, GBinaryPut b) => GBinaryPut (a :*: b)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
(GSumPut a, GSumPut b, SumSize a, SumSize b) => GBinaryPut (a :+: b)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan
GBinaryPut a => GBinaryPut (M1 i c a)Defined in binary-0.8.9.3 · Data.Binary.Generic · orphan

valuegetWord8 :: Get Word8

Read a Word8 from the monad state

newtypenewtype Get a

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
Functor GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
MonadFail GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
Applicative GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
Alternative GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
MonadPlus GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal

typetype Put = PutM ()

Put merely lifts Builder into a Writer monad, applied to ().

valueputWord8 :: Word8 -> Put

Efficiently write a byte into the output buffer

valuedecodeFile :: Binary a => FilePath -> IO a

Decode a value from a file. In case of errors, error will be called with the error message.

valuedecodeOrFail

:: Binary a
=> ByteString
-> Either (ByteString, ByteOffset, String) (ByteString, ByteOffset, a)

Decode a value from a lazy ByteString. Returning Left on failure and Right on success. In both cases the unconsumed input and the number of consumed bytes is returned. In case of failure, a human-readable error message will be returned as well.

valueencode :: Binary a => a -> ByteString

Encode a value using binary serialisation to a lazy ByteString.

valueencodeFile :: Binary a => FilePath -> a -> IO ()

Lazily serialise a value to a file.

This is just a convenience function, it's defined simply as:

encodeFile f = B.writeFile f . encode

So for example if you wanted to compress as well, you could use:

B.writeFile f . compress . encode

valuebitReverse16 :: Word16 -> Word16

Reverse the order of the bits in a Word16.

valuebitReverse32 :: Word32 -> Word32

Reverse the order of the bits in a Word32.

valuebitReverse64 :: Word64 -> Word64

Reverse the order of the bits in a Word64.

valuebitReverse8 :: Word8 -> Word8

Reverse the order of the bits in a Word8.

valuebyteSwap16 :: Word16 -> Word16

Reverse order of bytes in Word16.

valuebyteSwap32 :: Word32 -> Word32

Reverse order of bytes in Word32.

valuebyteSwap64 :: Word64 -> Word64

Reverse order of bytes in Word64.