Distribution.Utils.Structured

Structurally tag binary serialisaton stream. Useful when most Binary instances are Generic derived.

Say you have a data type

data Record = Record
  { _recordFields  :: HM.HashMap Text (Integer, ByteString)
  , _recordEnabled :: Bool
  }
  deriving (Eq, Show, Generic)

instance Binary Record
instance Structured Record

then you can serialise and deserialise Record values with a structure tag by simply

structuredEncode record :: ByteString
structuredDecode lbs :: IO Record

If structure of Record changes in between, deserialisation will fail early.

Technically, Structured is not related to Binary, and may be useful in other uses.

Encoding and decoding

These functions operate like binary's counterparts, but the serialised version has a structure hash in front.

structuredEncode :: forall a. (Binary a, Structured a) => a -> ByteString

Structured encode. Encode a value to using binary serialisation to a lazy ByteString. Encoding starts with 16 byte large structure hash.

structuredEncodeFile :: (Binary a, Structured a) => FilePath -> a -> IO ()

Lazily serialise a value to a file

structuredDecode :: forall a. (Binary a, Structured a) => ByteString -> a

Structured decode. Decode a value from a lazy ByteString, reconstructing the original structure. Throws pure exception on invalid inputs.

structuredDecodeOrFailIO :: (Binary a, Structured a) => ByteString -> IO (Either String a)

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

Lazily reconstruct a value previously written to a file.

Structured class

class Typeable a => Structured a where

Class of types with a known Structure.

For regular data types Structured can be derived generically.

data Record = Record { a :: Int, b :: Bool, c :: [Char] } deriving (Generic)
instance Structured Record

Since: 3.2.0.0

Minimal complete definition

Nothing

Methods

structure :: Proxy a -> Structure

structure :: (Generic a, GStructured (Rep a)) => Proxy a -> Structure

Instances

Structured Bool

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Bool -> Structure

structureHash' :: Tagged Bool MD5

Structured Char

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Char -> Structure

structureHash' :: Tagged Char MD5

Structured Double

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Double -> Structure

structureHash' :: Tagged Double MD5

Structured Float

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Float -> Structure

structureHash' :: Tagged Float MD5

Structured Int

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Int -> Structure

structureHash' :: Tagged Int MD5

Structured Int8

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Int8 -> Structure

structureHash' :: Tagged Int8 MD5

Structured Int16

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Int16 -> Structure

structureHash' :: Tagged Int16 MD5

Structured Int32

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Int32 -> Structure

structureHash' :: Tagged Int32 MD5

Structured Int64

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Int64 -> Structure

structureHash' :: Tagged Int64 MD5

Structured Integer

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Integer -> Structure

structureHash' :: Tagged Integer MD5

Structured Ordering

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Ordering -> Structure

structureHash' :: Tagged Ordering MD5

Structured Word

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Word -> Structure

structureHash' :: Tagged Word MD5

Structured Word8

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Word8 -> Structure

structureHash' :: Tagged Word8 MD5

Structured Word16

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Word16 -> Structure

structureHash' :: Tagged Word16 MD5

Structured Word32

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Word32 -> Structure

structureHash' :: Tagged Word32 MD5

Structured Word64

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Word64 -> Structure

structureHash' :: Tagged Word64 MD5

Structured ()

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy () -> Structure

structureHash' :: Tagged () MD5

Structured ByteString

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy ByteString -> Structure

structureHash' :: Tagged ByteString MD5

Structured ByteString

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy ByteString -> Structure

structureHash' :: Tagged ByteString MD5

Structured IntSet

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy IntSet -> Structure

structureHash' :: Tagged IntSet MD5

Structured Text

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Text -> Structure

structureHash' :: Tagged Text MD5

Structured Text

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Text -> Structure

structureHash' :: Tagged Text MD5

Structured LocalTime

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy LocalTime -> Structure

structureHash' :: Tagged LocalTime MD5

Structured TimeOfDay

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy TimeOfDay -> Structure

structureHash' :: Tagged TimeOfDay MD5

Structured TimeZone

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy TimeZone -> Structure

structureHash' :: Tagged TimeZone MD5

Structured UniversalTime

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy UniversalTime -> Structure

structureHash' :: Tagged UniversalTime MD5

Structured UTCTime

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy UTCTime -> Structure

structureHash' :: Tagged UTCTime MD5

Structured NominalDiffTime

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy NominalDiffTime -> Structure

structureHash' :: Tagged NominalDiffTime MD5

Structured DiffTime

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy DiffTime -> Structure

structureHash' :: Tagged DiffTime MD5

Structured Day

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy Day -> Structure

structureHash' :: Tagged Day MD5

Structured ShortText

Defined in Distribution.Utils.ShortText

Methods

structure :: Proxy ShortText -> Structure

structureHash' :: Tagged ShortText MD5

Structured PathTemplateVariable

Defined in Distribution.Simple.InstallDirs.Internal

Methods

structure :: Proxy PathTemplateVariable -> Structure

structureHash' :: Tagged PathTemplateVariable MD5

Structured PathComponent

Defined in Distribution.Simple.InstallDirs.Internal

Methods

structure :: Proxy PathComponent -> Structure

structureHash' :: Tagged PathComponent MD5

Structured Version

Defined in Distribution.Types.Version

Methods

structure :: Proxy Version -> Structure

structureHash' :: Tagged Version MD5

Structured VersionRange

Defined in Distribution.Types.VersionRange.Internal

Methods

structure :: Proxy VersionRange -> Structure

structureHash' :: Tagged VersionRange MD5

Structured RepoType

Defined in Distribution.Types.SourceRepo

Methods

structure :: Proxy RepoType -> Structure

structureHash' :: Tagged RepoType MD5

Structured RepoKind

Defined in Distribution.Types.SourceRepo

Methods

structure :: Proxy RepoKind -> Structure

structureHash' :: Tagged RepoKind MD5

Structured SourceRepo

Defined in Distribution.Types.SourceRepo

Methods

structure :: Proxy SourceRepo -> Structure

structureHash' :: Tagged SourceRepo MD5

Structured PkgconfigVersion

Defined in Distribution.Types.PkgconfigVersion

Methods

structure :: Proxy PkgconfigVersion -> Structure

structureHash' :: Tagged PkgconfigVersion MD5

Structured PkgconfigVersionRange

Defined in Distribution.Types.PkgconfigVersionRange

Methods

structure :: Proxy PkgconfigVersionRange -> Structure

structureHash' :: Tagged PkgconfigVersionRange MD5

Structured PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

structure :: Proxy PkgconfigName -> Structure

structureHash' :: Tagged PkgconfigName MD5

Structured PkgconfigDependency

Defined in Distribution.Types.PkgconfigDependency

Methods

structure :: Proxy PkgconfigDependency -> Structure

structureHash' :: Tagged PkgconfigDependency MD5

Structured PackageName

Defined in Distribution.Types.PackageName

Methods

structure :: Proxy PackageName -> Structure

structureHash' :: Tagged PackageName MD5

Structured UnqualComponentName

Defined in Distribution.Types.UnqualComponentName

Methods

structure :: Proxy UnqualComponentName -> Structure

structureHash' :: Tagged UnqualComponentName MD5

Structured PackageVersionConstraint

Defined in Distribution.Types.PackageVersionConstraint

Methods

structure :: Proxy PackageVersionConstraint -> Structure

structureHash' :: Tagged PackageVersionConstraint MD5

Structured LibraryVisibility

Defined in Distribution.Types.LibraryVisibility

Methods

structure :: Proxy LibraryVisibility -> Structure

structureHash' :: Tagged LibraryVisibility MD5

Structured LibraryName

Defined in Distribution.Types.LibraryName

Methods

structure :: Proxy LibraryName -> Structure

structureHash' :: Tagged LibraryName MD5

Structured MungedPackageName

Defined in Distribution.Types.MungedPackageName

Methods

structure :: Proxy MungedPackageName -> Structure

structureHash' :: Tagged MungedPackageName MD5

Structured ForeignLibType

Defined in Distribution.Types.ForeignLibType

Methods

structure :: Proxy ForeignLibType -> Structure

structureHash' :: Tagged ForeignLibType MD5

Structured ForeignLibOption

Defined in Distribution.Types.ForeignLibOption

Methods

structure :: Proxy ForeignLibOption -> Structure

structureHash' :: Tagged ForeignLibOption MD5

Structured FlagAssignment

Defined in Distribution.Types.Flag

Methods

structure :: Proxy FlagAssignment -> Structure

structureHash' :: Tagged FlagAssignment MD5

Structured FlagName

Defined in Distribution.Types.Flag

Methods

structure :: Proxy FlagName -> Structure

structureHash' :: Tagged FlagName MD5

Structured Flag

Defined in Distribution.Types.Flag

Methods

structure :: Proxy Flag -> Structure

structureHash' :: Tagged Flag MD5

Structured ExecutableScope

Defined in Distribution.Types.ExecutableScope

Methods

structure :: Proxy ExecutableScope -> Structure

structureHash' :: Tagged ExecutableScope MD5

Structured ComponentName

Defined in Distribution.Types.ComponentName

Methods

structure :: Proxy ComponentName -> Structure

structureHash' :: Tagged ComponentName MD5

Structured ComponentId

Defined in Distribution.Types.ComponentId

Methods

structure :: Proxy ComponentId -> Structure

structureHash' :: Tagged ComponentId MD5

Structured GivenComponent

Defined in Distribution.Types.GivenComponent

Methods

structure :: Proxy GivenComponent -> Structure

structureHash' :: Tagged GivenComponent MD5

Structured BuildType

Defined in Distribution.Types.BuildType

Methods

structure :: Proxy BuildType -> Structure

structureHash' :: Tagged BuildType MD5

Structured AbiHash

Defined in Distribution.Types.AbiHash

Methods

structure :: Proxy AbiHash -> Structure

structureHash' :: Tagged AbiHash MD5

Structured Platform

Defined in Distribution.System

Methods

structure :: Proxy Platform -> Structure

structureHash' :: Tagged Platform MD5

Structured Arch

Defined in Distribution.System

Methods

structure :: Proxy Arch -> Structure

structureHash' :: Tagged Arch MD5

Structured OS

Defined in Distribution.System

Methods

structure :: Proxy OS -> Structure

structureHash' :: Tagged OS MD5

Structured LicenseRef

Defined in Distribution.SPDX.LicenseReference

Methods

structure :: Proxy LicenseRef -> Structure

structureHash' :: Tagged LicenseRef MD5

Structured LicenseId

Defined in Distribution.SPDX.LicenseId

Methods

structure :: Proxy LicenseId -> Structure

structureHash' :: Tagged LicenseId MD5

Structured LicenseExceptionId

Defined in Distribution.SPDX.LicenseExceptionId

Methods

structure :: Proxy LicenseExceptionId -> Structure

structureHash' :: Tagged LicenseExceptionId MD5

Structured SimpleLicenseExpression

Defined in Distribution.SPDX.LicenseExpression

Methods

structure :: Proxy SimpleLicenseExpression -> Structure

structureHash' :: Tagged SimpleLicenseExpression MD5

Structured LicenseExpression

Defined in Distribution.SPDX.LicenseExpression

Methods

structure :: Proxy LicenseExpression -> Structure

structureHash' :: Tagged LicenseExpression MD5

Structured License

Defined in Distribution.SPDX.License

Methods

structure :: Proxy License -> Structure

structureHash' :: Tagged License MD5

Structured ModuleName

Defined in Distribution.ModuleName

Methods

structure :: Proxy ModuleName -> Structure

structureHash' :: Tagged ModuleName MD5

Structured ModuleRenaming

Defined in Distribution.Types.ModuleRenaming

Methods

structure :: Proxy ModuleRenaming -> Structure

structureHash' :: Tagged ModuleRenaming MD5

Structured IncludeRenaming

Defined in Distribution.Types.IncludeRenaming

Methods

structure :: Proxy IncludeRenaming -> Structure

structureHash' :: Tagged IncludeRenaming MD5

Structured Mixin

Defined in Distribution.Types.Mixin

Methods

structure :: Proxy Mixin -> Structure

structureHash' :: Tagged Mixin MD5

Structured ModuleReexport

Defined in Distribution.Types.ModuleReexport

Methods

structure :: Proxy ModuleReexport -> Structure

structureHash' :: Tagged ModuleReexport MD5

Structured VerbosityFlag

Defined in Distribution.Verbosity.Internal

Methods

structure :: Proxy VerbosityFlag -> Structure

structureHash' :: Tagged VerbosityFlag MD5

Structured VerbosityLevel

Defined in Distribution.Verbosity.Internal

Methods

structure :: Proxy VerbosityLevel -> Structure

structureHash' :: Tagged VerbosityLevel MD5

Structured Verbosity

Defined in Distribution.Verbosity

Methods

structure :: Proxy Verbosity -> Structure

structureHash' :: Tagged Verbosity MD5

Structured TestType

Defined in Distribution.Types.TestType

Methods

structure :: Proxy TestType -> Structure

structureHash' :: Tagged TestType MD5

Structured TestSuiteInterface

Defined in Distribution.Types.TestSuiteInterface

Methods

structure :: Proxy TestSuiteInterface -> Structure

structureHash' :: Tagged TestSuiteInterface MD5

Structured PackageIdentifier

Defined in Distribution.Types.PackageId

Methods

structure :: Proxy PackageIdentifier -> Structure

structureHash' :: Tagged PackageIdentifier MD5

Structured DefUnitId

Defined in Distribution.Types.UnitId

Methods

structure :: Proxy DefUnitId -> Structure

structureHash' :: Tagged DefUnitId MD5

Structured UnitId

Defined in Distribution.Types.UnitId

Methods

structure :: Proxy UnitId -> Structure

structureHash' :: Tagged UnitId MD5

Structured Module

Defined in Distribution.Types.Module

Methods

structure :: Proxy Module -> Structure

structureHash' :: Tagged Module MD5

Structured OpenModule

Defined in Distribution.Backpack

Methods

structure :: Proxy OpenModule -> Structure

structureHash' :: Tagged OpenModule MD5

Structured OpenUnitId

Defined in Distribution.Backpack

Methods

structure :: Proxy OpenUnitId -> Structure

structureHash' :: Tagged OpenUnitId MD5

Structured ExposedModule

Defined in Distribution.Types.ExposedModule

Methods

structure :: Proxy ExposedModule -> Structure

structureHash' :: Tagged ExposedModule MD5

Structured MungedPackageId

Defined in Distribution.Types.MungedPackageId

Methods

structure :: Proxy MungedPackageId -> Structure

structureHash' :: Tagged MungedPackageId MD5

Structured LegacyExeDependency

Defined in Distribution.Types.LegacyExeDependency

Methods

structure :: Proxy LegacyExeDependency -> Structure

structureHash' :: Tagged LegacyExeDependency MD5

Structured ExeDependency

Defined in Distribution.Types.ExeDependency

Methods

structure :: Proxy ExeDependency -> Structure

structureHash' :: Tagged ExeDependency MD5

Structured Dependency

Defined in Distribution.Types.Dependency

Methods

structure :: Proxy Dependency -> Structure

structureHash' :: Tagged Dependency MD5

Structured SetupBuildInfo

Defined in Distribution.Types.SetupBuildInfo

Methods

structure :: Proxy SetupBuildInfo -> Structure

structureHash' :: Tagged SetupBuildInfo MD5

Structured BenchmarkType

Defined in Distribution.Types.BenchmarkType

Methods

structure :: Proxy BenchmarkType -> Structure

structureHash' :: Tagged BenchmarkType MD5

Structured BenchmarkInterface

Defined in Distribution.Types.BenchmarkInterface

Methods

structure :: Proxy BenchmarkInterface -> Structure

structureHash' :: Tagged BenchmarkInterface MD5

Structured AbiDependency

Defined in Distribution.Types.AbiDependency

Methods

structure :: Proxy AbiDependency -> Structure

structureHash' :: Tagged AbiDependency MD5

Structured License

Defined in Distribution.License

Methods

structure :: Proxy License -> Structure

structureHash' :: Tagged License MD5

Structured InstalledPackageInfo

Defined in Distribution.Types.InstalledPackageInfo

Methods

structure :: Proxy InstalledPackageInfo -> Structure

structureHash' :: Tagged InstalledPackageInfo MD5

Structured KnownExtension

Defined in Language.Haskell.Extension

Methods

structure :: Proxy KnownExtension -> Structure

structureHash' :: Tagged KnownExtension MD5

Structured Extension

Defined in Language.Haskell.Extension

Methods

structure :: Proxy Extension -> Structure

structureHash' :: Tagged Extension MD5

Structured Language

Defined in Language.Haskell.Extension

Methods

structure :: Proxy Language -> Structure

structureHash' :: Tagged Language MD5

Structured AbiTag

Defined in Distribution.Compiler

Methods

structure :: Proxy AbiTag -> Structure

structureHash' :: Tagged AbiTag MD5

Structured CompilerId

Defined in Distribution.Compiler

Methods

structure :: Proxy CompilerId -> Structure

structureHash' :: Tagged CompilerId MD5

Structured CompilerFlavor

Defined in Distribution.Compiler

Methods

structure :: Proxy CompilerFlavor -> Structure

structureHash' :: Tagged CompilerFlavor MD5

Structured ConfVar

Defined in Distribution.Types.ConfVar

Methods

structure :: Proxy ConfVar -> Structure

structureHash' :: Tagged ConfVar MD5

Structured BuildInfo

Defined in Distribution.Types.BuildInfo

Methods

structure :: Proxy BuildInfo -> Structure

structureHash' :: Tagged BuildInfo MD5

Structured TestSuite

Defined in Distribution.Types.TestSuite

Methods

structure :: Proxy TestSuite -> Structure

structureHash' :: Tagged TestSuite MD5

Structured Library

Defined in Distribution.Types.Library

Methods

structure :: Proxy Library -> Structure

structureHash' :: Tagged Library MD5

Structured LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

structure :: Proxy LibVersionInfo -> Structure

structureHash' :: Tagged LibVersionInfo MD5

Structured ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

structure :: Proxy ForeignLib -> Structure

structureHash' :: Tagged ForeignLib MD5

Structured Executable

Defined in Distribution.Types.Executable

Methods

structure :: Proxy Executable -> Structure

structureHash' :: Tagged Executable MD5

Structured Benchmark

Defined in Distribution.Types.Benchmark

Methods

structure :: Proxy Benchmark -> Structure

structureHash' :: Tagged Benchmark MD5

Structured ComponentRequestedSpec

Defined in Distribution.Types.ComponentRequestedSpec

Methods

structure :: Proxy ComponentRequestedSpec -> Structure

structureHash' :: Tagged ComponentRequestedSpec MD5

Structured PackageDescription

Defined in Distribution.Types.PackageDescription

Methods

structure :: Proxy PackageDescription -> Structure

structureHash' :: Tagged PackageDescription MD5

Structured GenericPackageDescription

Defined in Distribution.Types.GenericPackageDescription

Methods

structure :: Proxy GenericPackageDescription -> Structure

structureHash' :: Tagged GenericPackageDescription MD5

Structured PathTemplate

Defined in Distribution.Simple.InstallDirs

Methods

structure :: Proxy PathTemplate -> Structure

structureHash' :: Tagged PathTemplate MD5

Structured ProgramSearchPathEntry

Defined in Distribution.Simple.Program.Find

Methods

structure :: Proxy ProgramSearchPathEntry -> Structure

structureHash' :: Tagged ProgramSearchPathEntry MD5

Structured ProgramLocation

Defined in Distribution.Simple.Program.Types

Methods

structure :: Proxy ProgramLocation -> Structure

structureHash' :: Tagged ProgramLocation MD5

Structured ConfiguredProgram

Defined in Distribution.Simple.Program.Types

Methods

structure :: Proxy ConfiguredProgram -> Structure

structureHash' :: Tagged ConfiguredProgram MD5

Structured ProfDetailLevel

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy ProfDetailLevel -> Structure

structureHash' :: Tagged ProfDetailLevel MD5

Structured DebugInfoLevel

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy DebugInfoLevel -> Structure

structureHash' :: Tagged DebugInfoLevel MD5

Structured OptimisationLevel

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy OptimisationLevel -> Structure

structureHash' :: Tagged OptimisationLevel MD5

Structured PackageDB

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy PackageDB -> Structure

structureHash' :: Tagged PackageDB MD5

Structured Compiler

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy Compiler -> Structure

structureHash' :: Tagged Compiler MD5

Structured ProgramDb

Defined in Distribution.Simple.Program.Db

Methods

structure :: Proxy ProgramDb -> Structure

structureHash' :: Tagged ProgramDb MD5

Structured TestShowDetails

Defined in Distribution.Simple.Setup

Methods

structure :: Proxy TestShowDetails -> Structure

structureHash' :: Tagged TestShowDetails MD5

Structured HaddockTarget

Defined in Distribution.Simple.Setup

Methods

structure :: Proxy HaddockTarget -> Structure

structureHash' :: Tagged HaddockTarget MD5

Structured ConfigFlags

Defined in Distribution.Simple.Setup

Methods

structure :: Proxy ConfigFlags -> Structure

structureHash' :: Tagged ConfigFlags MD5

Structured ComponentLocalBuildInfo

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

structure :: Proxy ComponentLocalBuildInfo -> Structure

structureHash' :: Tagged ComponentLocalBuildInfo MD5

Structured LocalBuildInfo

Defined in Distribution.Types.LocalBuildInfo

Methods

structure :: Proxy LocalBuildInfo -> Structure

structureHash' :: Tagged LocalBuildInfo MD5

Structured ModuleShape

Defined in Distribution.Backpack.ModuleShape

Methods

structure :: Proxy ModuleShape -> Structure

structureHash' :: Tagged ModuleShape MD5

Structured ModTime

Defined in Distribution.Compat.Time

Methods

structure :: Proxy ModTime -> Structure

structureHash' :: Tagged ModTime MD5

Structured a => Structured [a]

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy [a] -> Structure

structureHash' :: Tagged [a] MD5

Structured a => Structured (Maybe a)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (Maybe a) -> Structure

structureHash' :: Tagged (Maybe a) MD5

Structured a => Structured (Ratio a)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (Ratio a) -> Structure

structureHash' :: Tagged (Ratio a) MD5

Structured a => Structured (NonEmpty a)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (NonEmpty a) -> Structure

structureHash' :: Tagged (NonEmpty a) MD5

Structured v => Structured (IntMap v)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (IntMap v) -> Structure

structureHash' :: Tagged (IntMap v) MD5

Structured v => Structured (Seq v)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (Seq v) -> Structure

structureHash' :: Tagged (Seq v) MD5

Structured k => Structured (Set k)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (Set k) -> Structure

structureHash' :: Tagged (Set k) MD5

Structured a => Structured (Option' a)

Defined in Distribution.Compat.Semigroup

Methods

structure :: Proxy (Option' a) -> Structure

structureHash' :: Tagged (Option' a) MD5

Structured a => Structured (Last' a)

Defined in Distribution.Compat.Semigroup

Methods

structure :: Proxy (Last' a) -> Structure

structureHash' :: Tagged (Last' a) MD5

Structured c => Structured (Condition c)

Defined in Distribution.Types.Condition

Methods

structure :: Proxy (Condition c) -> Structure

structureHash' :: Tagged (Condition c) MD5

Structured a => Structured (Flag a)

Defined in Distribution.Simple.Flag

Methods

structure :: Proxy (Flag a) -> Structure

structureHash' :: Tagged (Flag a) MD5

Structured a => Structured (Graph a)

Defined in Distribution.Compat.Graph

Methods

structure :: Proxy (Graph a) -> Structure

structureHash' :: Tagged (Graph a) MD5

Structured a => Structured (PerCompilerFlavor a)

Defined in Distribution.Compiler

Methods

structure :: Proxy (PerCompilerFlavor a) -> Structure

structureHash' :: Tagged (PerCompilerFlavor a) MD5

Structured dir => Structured (InstallDirs dir)

Defined in Distribution.Simple.InstallDirs

Methods

structure :: Proxy (InstallDirs dir) -> Structure

structureHash' :: Tagged (InstallDirs dir) MD5

Structured a => Structured (NubList a)

Defined in Distribution.Utils.NubList

Methods

structure :: Proxy (NubList a) -> Structure

structureHash' :: Tagged (NubList a) MD5

Structured a => Structured (PackageIndex a)

Defined in Distribution.Simple.PackageIndex

Methods

structure :: Proxy (PackageIndex a) -> Structure

structureHash' :: Tagged (PackageIndex a) MD5

(Structured a, Structured b) => Structured (Either a b)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (Either a b) -> Structure

structureHash' :: Tagged (Either a b) MD5

(Structured a1, Structured a2) => Structured (a1, a2)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (a1, a2) -> Structure

structureHash' :: Tagged (a1, a2) MD5

(Structured k, Structured v) => Structured (Map k v)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (Map k v) -> Structure

structureHash' :: Tagged (Map k v) MD5

(Structured a1, Structured a2, Structured a3) => Structured (a1, a2, a3)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (a1, a2, a3) -> Structure

structureHash' :: Tagged (a1, a2, a3) MD5

(Structured v, Structured c, Structured a) => Structured (CondBranch v c a)

Defined in Distribution.Types.CondTree

Methods

structure :: Proxy (CondBranch v c a) -> Structure

structureHash' :: Tagged (CondBranch v c a) MD5

(Structured v, Structured c, Structured a) => Structured (CondTree v c a)

Defined in Distribution.Types.CondTree

Methods

structure :: Proxy (CondTree v c a) -> Structure

structureHash' :: Tagged (CondTree v c a) MD5

(Structured a1, Structured a2, Structured a3, Structured a4) => Structured (a1, a2, a3, a4)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (a1, a2, a3, a4) -> Structure

structureHash' :: Tagged (a1, a2, a3, a4) MD5

(Structured a1, Structured a2, Structured a3, Structured a4, Structured a5) => Structured (a1, a2, a3, a4, a5)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (a1, a2, a3, a4, a5) -> Structure

structureHash' :: Tagged (a1, a2, a3, a4, a5) MD5

(Structured a1, Structured a2, Structured a3, Structured a4, Structured a5, Structured a6) => Structured (a1, a2, a3, a4, a5, a6)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (a1, a2, a3, a4, a5, a6) -> Structure

structureHash' :: Tagged (a1, a2, a3, a4, a5, a6) MD5

(Structured a1, Structured a2, Structured a3, Structured a4, Structured a5, Structured a6, Structured a7) => Structured (a1, a2, a3, a4, a5, a6, a7)

Defined in Distribution.Utils.Structured

Methods

structure :: Proxy (a1, a2, a3, a4, a5, a6, a7) -> Structure

structureHash' :: Tagged (a1, a2, a3, a4, a5, a6, a7) MD5

type MD5 = Fingerprint

structureHash :: forall a. Structured a => Proxy a -> MD5

Semantically hashStructure . structure.

structureBuilder :: Structure -> Builder

Flatten Structure into something we can calculate hash of.

As Structure can be potentially infinite. For mutually recursive types, we keep track of TypeReps, and put just TypeRep name when it's occurred another time.

genericStructure :: forall a. (Typeable a, Generic a, GStructured (Rep a)) => Proxy a -> Structure

Derive structure genrically.

class GStructured (f :: Type -> Type)

Used to implement genericStructure.

Minimal complete definition

gstructured

Instances

(i ~ D, Datatype c, GStructuredSum f) => GStructured (M1 i c f)

Defined in Distribution.Utils.Structured

Methods

gstructured :: TypeRep -> Proxy (M1 i c f) -> TypeVersion -> Structure

nominalStructure :: Typeable a => Proxy a -> Structure

Use Typeable to infer name

containerStructure :: forall f a. (Typeable f, Structured a) => Proxy (f a) -> Structure

Structure type

data Structure

Structure of a datatype.

It can be infinite, as far as TypeReps involved are finite. (e.g. polymorphic recursion might cause troubles).

Constructors

Nominal !TypeRep !TypeVersion TypeName [Structure]

nominal, yet can be parametrised by other structures.

Newtype !TypeRep !TypeVersion TypeName Structure

a newtype wrapper

Structure !TypeRep !TypeVersion TypeName SopStructure

sum-of-products structure

Instances

Eq Structure

Defined in Distribution.Utils.Structured

Methods

(==) :: Structure -> Structure -> Bool

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

Ord Structure

Defined in Distribution.Utils.Structured

Methods

compare :: Structure -> Structure -> Ordering

(<) :: Structure -> Structure -> Bool

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

(>) :: Structure -> Structure -> Bool

(>=) :: Structure -> Structure -> Bool

max :: Structure -> Structure -> Structure

min :: Structure -> Structure -> Structure

Show Structure

Defined in Distribution.Utils.Structured

Methods

showsPrec :: Int -> Structure -> ShowS

show :: Structure -> String

showList :: [Structure] -> ShowS

Generic Structure

Defined in Distribution.Utils.Structured

Associated Types

type Rep Structure :: Type -> Type

Methods

from :: Structure -> Rep Structure x

to :: Rep Structure x -> Structure

type Rep Structure

Defined in Distribution.Utils.Structured

type Rep Structure = D1 (MetaData "Structure" "Distribution.Utils.Structured" "Cabal-3.2.1.0-64u7C0qYIFUDCJD6V8fmPr" False) (C1 (MetaCons "Nominal" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TypeRep) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TypeVersion)) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TypeName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Structure]))) :+: (C1 (MetaCons "Newtype" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TypeRep) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TypeVersion)) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TypeName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Structure))) :+: C1 (MetaCons "Structure" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TypeRep) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TypeVersion)) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TypeName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SopStructure)))))

type TypeName = String

type ConstructorName = String

type TypeVersion = Word32

A sematic version of a data type. Usually 0.

type SopStructure = [(ConstructorName, [Structure])]

hashStructure :: Structure -> MD5

A MD5 hash digest of Structure.

typeVersion :: Functor f => (TypeVersion -> f TypeVersion) -> Structure -> f Structure

A van-Laarhoven lens into TypeVersion of Structure

typeVersion :: Lens' Structure TypeVersion

typeName :: Functor f => (TypeName -> f TypeName) -> Structure -> f Structure

A van-Laarhoven lens into TypeName of Structure

typeName :: Lens' Structure TypeName