GHC.Utils.Binary

Like a Bin but is used to store relative offset pointers. Relative offset pointers store a relative location, but also contain an anchor that allow to obtain the absolute offset.

Read a relative offset location and wrap it in RelBin.

The resulting RelBin can be translated into an absolute offset location using makeAbsoluteBin

Do not rely on instance sizes for general types, we use variable length encoding for many of them.

A read-only handle that can be used to deserialise binary data from a buffer.

The buffer is an unboxed binary array.

A write-only handle that can be used to serialise binary data into a buffer.

The buffer is an unboxed binary array.

Symbols that are read from disk. The SymbolTable index starts on '0'.

A SymbolTable of FastStrings.

SeekBin but without calling expandBin

Get access to the underlying buffer.

Freeze the given WriteBinHandle and turn it into an equivalent ReadBinHandle.

The current offset of the WriteBinHandle is maintained in the new ReadBinHandle.

Copy the BinBuffer to a new BinBuffer which is exactly the right size. This performs a copy of the underlying buffer. The buffer may be truncated if the offset is not at the end of the written output.

UserData is also discarded during the copy You should just use this when translating a Put handle into a Get handle.

forwardPut put_A put_B outputs A after B but allows A to be read before B by using a forward reference.

Read a value stored using a forward reference

The forward reference is expected to be an absolute offset.

forwardPutRel put_A put_B outputs A after B but allows A to be read before B by using a forward reference.

This forward reference is a relative offset that allows us to skip over the result of put_A.

Like forwardGetRel, but discard the result.

Read a value stored using a forward reference.

The forward reference is expected to be a relative offset.

Put a ByteString without its length (can't be read back without knowing the length!)

Get a ByteString whose length is known

Encode the argument in its full length. This is different from many default binary instances which make no guarantee about the actual encoding and might do things using variable length encoding.

Deserialize a value serialized by lazyPutMaybe.

Serialize the constructor strictly but lazily serialize a value inside a Just.

This way we can check for the presence of a value without deserializing the value itself.

UserData required to deserialise symbols for interface files.

See Note [Binary UserData]

UserData required to serialise symbols for interface files.

See Note [Binary UserData]

Add SomeBinaryReader as a known binary decoder. If a BinaryReader for the associated type already exists in ReaderUserData, it is overwritten.

Add SomeBinaryWriter as a known binary encoder. If a BinaryWriter for the associated type already exists in WriterUserData, it is overwritten.

Find the BinaryReader for the Binary instance for the type identified by 'Proxy a'.

If no BinaryReader has been configured before, this function will panic.

Find the BinaryWriter for the Binary instance for the type identified by 'Proxy a'.

If no BinaryWriter has been configured before, this function will panic.

Existential for BinaryReader with a type witness.

Existential for BinaryWriter with a type witness.

A ReaderTable describes how to deserialise a table from disk, and how to create a BinaryReader that looks up values in the deduplication table.

A WriterTable is an interface any deduplication table can implement to describe how the table can be written to disk.

The GenericSymbolTable stores a mapping from already seen elements to an index. If an element wasn't seen before, it is added to the mapping together with a fresh index.

GenericSymbolTable is a variant of a BinSymbolTable that is polymorphic in the table implementation. As such it can be used with any container that implements the TrieMap type class.

While GenericSymbolTable is similar to the BinSymbolTable, it supports storing tree-like structures such as Type and IfaceType more efficiently.

Initialise a GenericSymbolTable, initialising the index to '0'.

Read a value from a SymbolTable.

Write an element 'Key m' to the given WriteBinHandle.

If the element was seen before, we simply write the index of that element to the WriteBinHandle. If we haven't seen it before, we add the element to the GenericSymbolTable, increment the index, and return this new index.

Read the elements of a GenericSymbolTable from disk into a SymbolTable.

Serialise the GenericSymbolTable to disk.

Since GenericSymbolTable stores tree-like structures, such as IfaceType, serialising an element can add new elements to the mapping. Thus, putGenericSymbolTable first serialises all values, and then checks whether any new elements have been discovered. If so, repeat the loop.

Newtype to serialise binding names differently to non-binding Name. See Note [Binary UserData]

FullBinData stores a slice to a BinArray.

It requires less memory than ReadBinHandle, and can be constructed from a ReadBinHandle via freezeBinHandle and turned back into a ReadBinHandle using thawBinHandle. Additionally, the byte array slice can be put into a WriteBinHandle without extra conversions via putFullBinData.

Freeze a ReadBinHandle and a start index into a FullBinData.

FullBinData stores a slice starting from the 'Bin a' location to the current offset of the ReadBinHandle.

Turn the FullBinData into a ReadBinHandle, setting the ReadBinHandle offset to the start of the FullBinData and restore the ReaderUserData that was obtained from freezeBinHandle.

Write the FullBinData slice into the WriteBinHandle.

A wrapper which allows us to store a fingerprint and optionally the value which was used to create the fingerprint.