Copyright	(c) 2019 Oleg Grenrus
Safe Haskell	None
Language	Haskell2010

Distribution.Utils.Structured

Contents

Encoding and decoding
Structured class
Structure type

Description

Structurally tag binary serialisation 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.

Synopsis

structuredEncode :: (Binary a, Structured a) => a -> ByteString
structuredEncodeFile :: (Binary a, Structured a) => FilePath -> a -> IO ()
structuredDecode :: (Binary a, Structured a) => ByteString -> a
structuredDecodeOrFailIO :: (Binary a, Structured a) => ByteString -> IO (Either String a)
structuredDecodeFileOrFail :: (Binary a, Structured a) => FilePath -> IO (Either String a)
class Typeable a => Structured a where
- structure :: Proxy a -> Structure
type MD5 = Fingerprint
structureHash :: Structured a => Proxy a -> MD5
structureBuilder :: Structure -> Builder
genericStructure :: (Typeable a, Generic a, GStructured (Rep a)) => Proxy a -> Structure
class GStructured (f :: Type -> Type)
nominalStructure :: forall {k} (a :: k). Typeable a => Proxy a -> Structure
containerStructure :: forall {k} (f :: Type -> k) a. (Typeable f, Structured a) => Proxy (f a) -> Structure
data Structure
- = Nominal !TypeRep !TypeVersion TypeName [Structure]
- | Newtype !TypeRep !TypeVersion TypeName Structure
- | Structure !TypeRep !TypeVersion TypeName SopStructure
data Tag (a :: k) = Tag
type TypeName = String
type ConstructorName = String
type TypeVersion = Word32
type SopStructure = [(ConstructorName, [Structure])]
hashStructure :: Structure -> MD5
typeVersion :: Functor f => (TypeVersion -> f TypeVersion) -> Structure -> f Structure
typeName :: Functor f => (TypeName -> f TypeName) -> Structure -> f Structure

Encoding and decoding

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

structuredEncode :: (Binary a, Structured a) => a -> ByteString Source #

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 () Source #

Lazily serialise a value to a file

structuredDecode :: (Binary a, Structured a) => ByteString -> a Source #

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) Source #

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

Lazily reconstruct a value previously written to a file.

Structured class

class Typeable a => Structured a where Source #

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: Cabal-syntax-3.2.0.0

Minimal complete definition

Nothing

Methods

structure :: Proxy a -> Structure Source #

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

Instances

Instances details

Structured OpenModule Source #
Instance details Defined in Distribution.Backpack Methods structure :: Proxy OpenModule -> Structure Source # structureHash' :: Tagged OpenModule MD5
Structured OpenUnitId Source #
Instance details Defined in Distribution.Backpack Methods structure :: Proxy OpenUnitId -> Structure Source # structureHash' :: Tagged OpenUnitId MD5
Structured CabalSpecVersion Source #
Instance details Defined in Distribution.CabalSpecVersion Methods structure :: Proxy CabalSpecVersion -> Structure Source # structureHash' :: Tagged CabalSpecVersion MD5
Structured AbiTag Source #
Instance details Defined in Distribution.Compiler Methods structure :: Proxy AbiTag -> Structure Source # structureHash' :: Tagged AbiTag MD5
Structured CompilerFlavor Source #
Instance details Defined in Distribution.Compiler Methods structure :: Proxy CompilerFlavor -> Structure Source # structureHash' :: Tagged CompilerFlavor MD5
Structured CompilerId Source #
Instance details Defined in Distribution.Compiler Methods structure :: Proxy CompilerId -> Structure Source # structureHash' :: Tagged CompilerId MD5
Structured License Source #
Instance details Defined in Distribution.License Methods structure :: Proxy License -> Structure Source # structureHash' :: Tagged License MD5
Structured ModuleName Source #
Instance details Defined in Distribution.ModuleName Methods structure :: Proxy ModuleName -> Structure Source # structureHash' :: Tagged ModuleName MD5
Structured License Source #
Instance details Defined in Distribution.SPDX.License Methods structure :: Proxy License -> Structure Source # structureHash' :: Tagged License MD5
Structured LicenseExceptionId Source #
Instance details Defined in Distribution.SPDX.LicenseExceptionId Methods structure :: Proxy LicenseExceptionId -> Structure Source # structureHash' :: Tagged LicenseExceptionId MD5
Structured LicenseExpression Source #
Instance details Defined in Distribution.SPDX.LicenseExpression Methods structure :: Proxy LicenseExpression -> Structure Source # structureHash' :: Tagged LicenseExpression MD5
Structured SimpleLicenseExpression Source #
Instance details Defined in Distribution.SPDX.LicenseExpression Methods structure :: Proxy SimpleLicenseExpression -> Structure Source # structureHash' :: Tagged SimpleLicenseExpression MD5
Structured LicenseId Source #
Instance details Defined in Distribution.SPDX.LicenseId Methods structure :: Proxy LicenseId -> Structure Source # structureHash' :: Tagged LicenseId MD5
Structured LicenseRef Source #
Instance details Defined in Distribution.SPDX.LicenseReference Methods structure :: Proxy LicenseRef -> Structure Source # structureHash' :: Tagged LicenseRef MD5
Structured Arch Source #
Instance details Defined in Distribution.System Methods structure :: Proxy Arch -> Structure Source # structureHash' :: Tagged Arch MD5
Structured OS Source #
Instance details Defined in Distribution.System Methods structure :: Proxy OS -> Structure Source # structureHash' :: Tagged OS MD5
Structured Platform Source #
Instance details Defined in Distribution.System Methods structure :: Proxy Platform -> Structure Source # structureHash' :: Tagged Platform MD5
Structured AbiDependency Source #
Instance details Defined in Distribution.Types.AbiDependency Methods structure :: Proxy AbiDependency -> Structure Source # structureHash' :: Tagged AbiDependency MD5
Structured AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods structure :: Proxy AbiHash -> Structure Source # structureHash' :: Tagged AbiHash MD5
Structured Benchmark Source #
Instance details Defined in Distribution.Types.Benchmark Methods structure :: Proxy Benchmark -> Structure Source # structureHash' :: Tagged Benchmark MD5
Structured BenchmarkInterface Source #
Instance details Defined in Distribution.Types.BenchmarkInterface Methods structure :: Proxy BenchmarkInterface -> Structure Source # structureHash' :: Tagged BenchmarkInterface MD5
Structured BenchmarkType Source #
Instance details Defined in Distribution.Types.BenchmarkType Methods structure :: Proxy BenchmarkType -> Structure Source # structureHash' :: Tagged BenchmarkType MD5
Structured BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods structure :: Proxy BuildInfo -> Structure Source # structureHash' :: Tagged BuildInfo MD5
Structured BuildType Source #
Instance details Defined in Distribution.Types.BuildType Methods structure :: Proxy BuildType -> Structure Source # structureHash' :: Tagged BuildType MD5
Structured ComponentId Source #
Instance details Defined in Distribution.Types.ComponentId Methods structure :: Proxy ComponentId -> Structure Source # structureHash' :: Tagged ComponentId MD5
Structured ComponentName Source #
Instance details Defined in Distribution.Types.ComponentName Methods structure :: Proxy ComponentName -> Structure Source # structureHash' :: Tagged ComponentName MD5
Structured ComponentRequestedSpec Source #
Instance details Defined in Distribution.Types.ComponentRequestedSpec Methods structure :: Proxy ComponentRequestedSpec -> Structure Source # structureHash' :: Tagged ComponentRequestedSpec MD5
Structured ConfVar Source #
Instance details Defined in Distribution.Types.ConfVar Methods structure :: Proxy ConfVar -> Structure Source # structureHash' :: Tagged ConfVar MD5
Structured Dependency Source #
Instance details Defined in Distribution.Types.Dependency Methods structure :: Proxy Dependency -> Structure Source # structureHash' :: Tagged Dependency MD5
Structured ExeDependency Source #
Instance details Defined in Distribution.Types.ExeDependency Methods structure :: Proxy ExeDependency -> Structure Source # structureHash' :: Tagged ExeDependency MD5
Structured Executable Source #
Instance details Defined in Distribution.Types.Executable Methods structure :: Proxy Executable -> Structure Source # structureHash' :: Tagged Executable MD5
Structured ExecutableScope Source #
Instance details Defined in Distribution.Types.ExecutableScope Methods structure :: Proxy ExecutableScope -> Structure Source # structureHash' :: Tagged ExecutableScope MD5
Structured ExposedModule Source #
Instance details Defined in Distribution.Types.ExposedModule Methods structure :: Proxy ExposedModule -> Structure Source # structureHash' :: Tagged ExposedModule MD5
Structured FlagAssignment Source #
Instance details Defined in Distribution.Types.Flag Methods structure :: Proxy FlagAssignment -> Structure Source # structureHash' :: Tagged FlagAssignment MD5
Structured FlagName Source #
Instance details Defined in Distribution.Types.Flag Methods structure :: Proxy FlagName -> Structure Source # structureHash' :: Tagged FlagName MD5
Structured PackageFlag Source #
Instance details Defined in Distribution.Types.Flag Methods structure :: Proxy PackageFlag -> Structure Source # structureHash' :: Tagged PackageFlag MD5
Structured ForeignLib Source #
Instance details Defined in Distribution.Types.ForeignLib Methods structure :: Proxy ForeignLib -> Structure Source # structureHash' :: Tagged ForeignLib MD5
Structured LibVersionInfo Source #
Instance details Defined in Distribution.Types.ForeignLib Methods structure :: Proxy LibVersionInfo -> Structure Source # structureHash' :: Tagged LibVersionInfo MD5
Structured ForeignLibOption Source #
Instance details Defined in Distribution.Types.ForeignLibOption Methods structure :: Proxy ForeignLibOption -> Structure Source # structureHash' :: Tagged ForeignLibOption MD5
Structured ForeignLibType Source #
Instance details Defined in Distribution.Types.ForeignLibType Methods structure :: Proxy ForeignLibType -> Structure Source # structureHash' :: Tagged ForeignLibType MD5
Structured GenericPackageDescription Source #
Instance details Defined in Distribution.Types.GenericPackageDescription Methods structure :: Proxy GenericPackageDescription -> Structure Source # structureHash' :: Tagged GenericPackageDescription MD5
Structured IncludeRenaming Source #
Instance details Defined in Distribution.Types.IncludeRenaming Methods structure :: Proxy IncludeRenaming -> Structure Source # structureHash' :: Tagged IncludeRenaming MD5
Structured InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods structure :: Proxy InstalledPackageInfo -> Structure Source # structureHash' :: Tagged InstalledPackageInfo MD5
Structured LegacyExeDependency Source #
Instance details Defined in Distribution.Types.LegacyExeDependency Methods structure :: Proxy LegacyExeDependency -> Structure Source # structureHash' :: Tagged LegacyExeDependency MD5
Structured Library Source #
Instance details Defined in Distribution.Types.Library Methods structure :: Proxy Library -> Structure Source # structureHash' :: Tagged Library MD5
Structured LibraryName Source #
Instance details Defined in Distribution.Types.LibraryName Methods structure :: Proxy LibraryName -> Structure Source # structureHash' :: Tagged LibraryName MD5
Structured LibraryVisibility Source #
Instance details Defined in Distribution.Types.LibraryVisibility Methods structure :: Proxy LibraryVisibility -> Structure Source # structureHash' :: Tagged LibraryVisibility MD5
Structured Mixin Source #
Instance details Defined in Distribution.Types.Mixin Methods structure :: Proxy Mixin -> Structure Source # structureHash' :: Tagged Mixin MD5
Structured Module Source #
Instance details Defined in Distribution.Types.Module Methods structure :: Proxy Module -> Structure Source # structureHash' :: Tagged Module MD5
Structured ModuleReexport Source #
Instance details Defined in Distribution.Types.ModuleReexport Methods structure :: Proxy ModuleReexport -> Structure Source # structureHash' :: Tagged ModuleReexport MD5
Structured ModuleRenaming Source #
Instance details Defined in Distribution.Types.ModuleRenaming Methods structure :: Proxy ModuleRenaming -> Structure Source # structureHash' :: Tagged ModuleRenaming MD5
Structured MungedPackageId Source #
Instance details Defined in Distribution.Types.MungedPackageId Methods structure :: Proxy MungedPackageId -> Structure Source # structureHash' :: Tagged MungedPackageId MD5
Structured MungedPackageName Source #
Instance details Defined in Distribution.Types.MungedPackageName Methods structure :: Proxy MungedPackageName -> Structure Source # structureHash' :: Tagged MungedPackageName MD5
Structured PackageDescription Source #
Instance details Defined in Distribution.Types.PackageDescription Methods structure :: Proxy PackageDescription -> Structure Source # structureHash' :: Tagged PackageDescription MD5
Structured PackageIdentifier Source #
Instance details Defined in Distribution.Types.PackageId Methods structure :: Proxy PackageIdentifier -> Structure Source # structureHash' :: Tagged PackageIdentifier MD5
Structured PackageName Source #
Instance details Defined in Distribution.Types.PackageName Methods structure :: Proxy PackageName -> Structure Source # structureHash' :: Tagged PackageName MD5
Structured PackageVersionConstraint Source #
Instance details Defined in Distribution.Types.PackageVersionConstraint Methods structure :: Proxy PackageVersionConstraint -> Structure Source # structureHash' :: Tagged PackageVersionConstraint MD5
Structured PkgconfigDependency Source #
Instance details Defined in Distribution.Types.PkgconfigDependency Methods structure :: Proxy PkgconfigDependency -> Structure Source # structureHash' :: Tagged PkgconfigDependency MD5
Structured PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods structure :: Proxy PkgconfigName -> Structure Source # structureHash' :: Tagged PkgconfigName MD5
Structured PkgconfigVersion Source #
Instance details Defined in Distribution.Types.PkgconfigVersion Methods structure :: Proxy PkgconfigVersion -> Structure Source # structureHash' :: Tagged PkgconfigVersion MD5
Structured PkgconfigVersionRange Source #
Instance details Defined in Distribution.Types.PkgconfigVersionRange Methods structure :: Proxy PkgconfigVersionRange -> Structure Source # structureHash' :: Tagged PkgconfigVersionRange MD5
Structured SetupBuildInfo Source #
Instance details Defined in Distribution.Types.SetupBuildInfo Methods structure :: Proxy SetupBuildInfo -> Structure Source # structureHash' :: Tagged SetupBuildInfo MD5
Structured KnownRepoType Source #
Instance details Defined in Distribution.Types.SourceRepo Methods structure :: Proxy KnownRepoType -> Structure Source # structureHash' :: Tagged KnownRepoType MD5
Structured RepoKind Source #
Instance details Defined in Distribution.Types.SourceRepo Methods structure :: Proxy RepoKind -> Structure Source # structureHash' :: Tagged RepoKind MD5
Structured RepoType Source #
Instance details Defined in Distribution.Types.SourceRepo Methods structure :: Proxy RepoType -> Structure Source # structureHash' :: Tagged RepoType MD5
Structured SourceRepo Source #
Instance details Defined in Distribution.Types.SourceRepo Methods structure :: Proxy SourceRepo -> Structure Source # structureHash' :: Tagged SourceRepo MD5
Structured TestSuite Source #
Instance details Defined in Distribution.Types.TestSuite Methods structure :: Proxy TestSuite -> Structure Source # structureHash' :: Tagged TestSuite MD5
Structured TestSuiteInterface Source #
Instance details Defined in Distribution.Types.TestSuiteInterface Methods structure :: Proxy TestSuiteInterface -> Structure Source # structureHash' :: Tagged TestSuiteInterface MD5
Structured TestType Source #
Instance details Defined in Distribution.Types.TestType Methods structure :: Proxy TestType -> Structure Source # structureHash' :: Tagged TestType MD5
Structured DefUnitId Source #
Instance details Defined in Distribution.Types.UnitId Methods structure :: Proxy DefUnitId -> Structure Source # structureHash' :: Tagged DefUnitId MD5
Structured UnitId Source #
Instance details Defined in Distribution.Types.UnitId Methods structure :: Proxy UnitId -> Structure Source # structureHash' :: Tagged UnitId MD5
Structured UnqualComponentName Source #
Instance details Defined in Distribution.Types.UnqualComponentName Methods structure :: Proxy UnqualComponentName -> Structure Source # structureHash' :: Tagged UnqualComponentName MD5
Structured Version Source #
Instance details Defined in Distribution.Types.Version Methods structure :: Proxy Version -> Structure Source # structureHash' :: Tagged Version MD5
Structured VersionRange Source #
Instance details Defined in Distribution.Types.VersionRange.Internal Methods structure :: Proxy VersionRange -> Structure Source # structureHash' :: Tagged VersionRange MD5
Structured ShortText Source #
Instance details Defined in Distribution.Utils.ShortText Methods structure :: Proxy ShortText -> Structure Source # structureHash' :: Tagged ShortText MD5
Structured Extension Source #
Instance details Defined in Language.Haskell.Extension Methods structure :: Proxy Extension -> Structure Source # structureHash' :: Tagged Extension MD5
Structured KnownExtension Source #
Instance details Defined in Language.Haskell.Extension Methods structure :: Proxy KnownExtension -> Structure Source # structureHash' :: Tagged KnownExtension MD5
Structured Language Source #
Instance details Defined in Language.Haskell.Extension Methods structure :: Proxy Language -> Structure Source # structureHash' :: Tagged Language MD5
Structured Int16 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Int16 -> Structure Source # structureHash' :: Tagged Int16 MD5
Structured Int32 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Int32 -> Structure Source # structureHash' :: Tagged Int32 MD5
Structured Int64 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Int64 -> Structure Source # structureHash' :: Tagged Int64 MD5
Structured Int8 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Int8 -> Structure Source # structureHash' :: Tagged Int8 MD5
Structured Word16 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Word16 -> Structure Source # structureHash' :: Tagged Word16 MD5
Structured Word32 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Word32 -> Structure Source # structureHash' :: Tagged Word32 MD5
Structured Word64 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Word64 -> Structure Source # structureHash' :: Tagged Word64 MD5
Structured Word8 Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Word8 -> Structure Source # structureHash' :: Tagged Word8 MD5
Structured ByteString Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy ByteString -> Structure Source # structureHash' :: Tagged ByteString MD5
Structured ByteString Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy ByteString -> Structure Source # structureHash' :: Tagged ByteString MD5
Structured IntSet Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy IntSet -> Structure Source # structureHash' :: Tagged IntSet MD5
Structured Ordering Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Ordering -> Structure Source # structureHash' :: Tagged Ordering MD5
Structured Text Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Text -> Structure Source # structureHash' :: Tagged Text MD5
Structured Text Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Text -> Structure Source # structureHash' :: Tagged Text MD5
Structured Day Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Day -> Structure Source # structureHash' :: Tagged Day MD5
Structured DiffTime Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy DiffTime -> Structure Source # structureHash' :: Tagged DiffTime MD5
Structured NominalDiffTime Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy NominalDiffTime -> Structure Source # structureHash' :: Tagged NominalDiffTime MD5
Structured UTCTime Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy UTCTime -> Structure Source # structureHash' :: Tagged UTCTime MD5
Structured UniversalTime Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy UniversalTime -> Structure Source # structureHash' :: Tagged UniversalTime MD5
Structured LocalTime Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy LocalTime -> Structure Source # structureHash' :: Tagged LocalTime MD5
Structured TimeOfDay Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy TimeOfDay -> Structure Source # structureHash' :: Tagged TimeOfDay MD5
Structured TimeZone Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy TimeZone -> Structure Source # structureHash' :: Tagged TimeZone MD5
Structured Integer Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Integer -> Structure Source # structureHash' :: Tagged Integer MD5
Structured () Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy () -> Structure Source # structureHash' :: Tagged () MD5
Structured Bool Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Bool -> Structure Source # structureHash' :: Tagged Bool MD5
Structured Char Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Char -> Structure Source # structureHash' :: Tagged Char MD5
Structured Double Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Double -> Structure Source # structureHash' :: Tagged Double MD5
Structured Float Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Float -> Structure Source # structureHash' :: Tagged Float MD5
Structured Int Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Int -> Structure Source # structureHash' :: Tagged Int MD5
Structured Word Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy Word -> Structure Source # structureHash' :: Tagged Word MD5
Structured a => Structured (Graph a) Source #
Instance details Defined in Distribution.Compat.Graph Methods structure :: Proxy (Graph a) -> Structure Source # structureHash' :: Tagged (Graph a) MD5
Structured a => Structured (NonEmptySet a) Source #
Instance details Defined in Distribution.Compat.NonEmptySet Methods structure :: Proxy (NonEmptySet a) -> Structure Source # structureHash' :: Tagged (NonEmptySet a) MD5
Structured a => Structured (Last' a) Source #
Instance details Defined in Distribution.Compat.Semigroup Methods structure :: Proxy (Last' a) -> Structure Source # structureHash' :: Tagged (Last' a) MD5
Structured a => Structured (Option' a) Source #
Instance details Defined in Distribution.Compat.Semigroup Methods structure :: Proxy (Option' a) -> Structure Source # structureHash' :: Tagged (Option' a) MD5
Structured a => Structured (PerCompilerFlavor a) Source #
Instance details Defined in Distribution.Compiler Methods structure :: Proxy (PerCompilerFlavor a) -> Structure Source # structureHash' :: Tagged (PerCompilerFlavor a) MD5
Structured c => Structured (Condition c) Source #
Instance details Defined in Distribution.Types.Condition Methods structure :: Proxy (Condition c) -> Structure Source # structureHash' :: Tagged (Condition c) MD5
Structured a => Structured (NonEmpty a) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (NonEmpty a) -> Structure Source # structureHash' :: Tagged (NonEmpty a) MD5
Structured a => Structured (Ratio a) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (Ratio a) -> Structure Source # structureHash' :: Tagged (Ratio a) MD5
Structured v => Structured (IntMap v) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (IntMap v) -> Structure Source # structureHash' :: Tagged (IntMap v) MD5
Structured v => Structured (Seq v) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (Seq v) -> Structure Source # structureHash' :: Tagged (Seq v) MD5
Structured k => Structured (Set k) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (Set k) -> Structure Source # structureHash' :: Tagged (Set k) MD5
Structured a => Structured (Maybe a) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (Maybe a) -> Structure Source # structureHash' :: Tagged (Maybe a) MD5
Structured a => Structured [a] Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy [a] -> Structure Source # structureHash' :: Tagged [a] MD5
(Typeable from, Typeable to) => Structured (SymbolicPath from to) Source #
Instance details Defined in Distribution.Utils.Path Methods structure :: Proxy (SymbolicPath from to) -> Structure Source # structureHash' :: Tagged (SymbolicPath from to) MD5
(Structured a, Structured b) => Structured (Either a b) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (Either a b) -> Structure Source # structureHash' :: Tagged (Either a b) MD5
(Structured k, Structured v) => Structured (Map k v) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (Map k v) -> Structure Source # structureHash' :: Tagged (Map k v) MD5
(Structured a1, Structured a2) => Structured (a1, a2) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (a1, a2) -> Structure Source # structureHash' :: Tagged (a1, a2) MD5
(Structured v, Structured c, Structured a) => Structured (CondBranch v c a) Source #
Instance details Defined in Distribution.Types.CondTree Methods structure :: Proxy (CondBranch v c a) -> Structure Source # structureHash' :: Tagged (CondBranch v c a) MD5
(Structured v, Structured c, Structured a) => Structured (CondTree v c a) Source #
Instance details Defined in Distribution.Types.CondTree Methods structure :: Proxy (CondTree v c a) -> Structure Source # structureHash' :: Tagged (CondTree v c a) MD5
(Structured a1, Structured a2, Structured a3) => Structured (a1, a2, a3) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (a1, a2, a3) -> Structure Source # structureHash' :: Tagged (a1, a2, a3) MD5
(Structured a1, Structured a2, Structured a3, Structured a4) => Structured (a1, a2, a3, a4) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (a1, a2, a3, a4) -> Structure Source # structureHash' :: Tagged (a1, a2, a3, a4) MD5
(Structured a1, Structured a2, Structured a3, Structured a4, Structured a5) => Structured (a1, a2, a3, a4, a5) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (a1, a2, a3, a4, a5) -> Structure Source # 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) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (a1, a2, a3, a4, a5, a6) -> Structure Source # 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) Source #
Instance details Defined in Distribution.Utils.Structured Methods structure :: Proxy (a1, a2, a3, a4, a5, a6, a7) -> Structure Source # structureHash' :: Tagged (a1, a2, a3, a4, a5, a6, a7) MD5

type MD5 = Fingerprint Source #

structureHash :: Structured a => Proxy a -> MD5 Source #

Semantically hashStructure . structure.

structureBuilder :: Structure -> Builder Source #

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 :: (Typeable a, Generic a, GStructured (Rep a)) => Proxy a -> Structure Source #

Derive structure generically.

class GStructured (f :: Type -> Type) Source #

Used to implement genericStructure.

Minimal complete definition

gstructured

Instances

Instances details

(i ~ D, Datatype c, GStructuredSum f) => GStructured (M1 i c f) Source #
Instance details Defined in Distribution.Utils.Structured Methods gstructured :: TypeRep -> Proxy (M1 i c f) -> TypeVersion -> Structure

nominalStructure :: forall {k} (a :: k). Typeable a => Proxy a -> Structure Source #

Use Typeable to infer name

containerStructure :: forall {k} (f :: Type -> k) a. (Typeable f, Structured a) => Proxy (f a) -> Structure Source #

Structure type

data Structure Source #

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

Instances details

Generic Structure Source #

Instance details

Defined in Distribution.Utils.Structured

Associated Types

type Rep Structure

Instance details

Defined in Distribution.Utils.Structured

Methods

from :: Structure -> Rep Structure x Source #

to :: Rep Structure x -> Structure Source #

Show Structure Source #

Instance details

Defined in Distribution.Utils.Structured

Methods

showsPrec :: Int -> Structure -> ShowS Source #

show :: Structure -> String Source #

showList :: [Structure] -> ShowS Source #

Eq Structure Source #

Instance details

Defined in Distribution.Utils.Structured

Methods

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

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

Ord Structure Source #

Instance details

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 #

type Rep Structure Source #

Instance details

Defined in Distribution.Utils.Structured

data Tag (a :: k) Source #

Constructors

Tag

Instances

Instances details

Structured a => Binary (Tag a) Source #
Instance details Defined in Distribution.Utils.Structured Methods put :: Tag a -> Put Source # get :: Get (Tag a) Source # putList :: [Tag a] -> Put Source #

type TypeName = String Source #

type ConstructorName = String Source #

type TypeVersion = Word32 Source #

A semantic version of a data type. Usually 0.

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

hashStructure :: Structure -> MD5 Source #

A MD5 hash digest of Structure.

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

A van-Laarhoven lens into TypeVersion of Structure

typeVersion :: Lens' Structure TypeVersion

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

A van-Laarhoven lens into TypeName of Structure

typeName :: Lens' Structure TypeName