package
0.0.0-20220913055112-2b1eae4ebed9
Repository: https://github.com/iotaledger/trie.go.git
Documentation: pkg.go.dev

# README

Package trie256p

Package contain implementation of generic trie256+. It essentially follows 256+ trie. Definition.

# Functions

Assert simple assertion with message formatting.
No description provided by the author
ByteSize computes byte size of the serialized key/value iterator assumes 2 bytes per key length and 4 bytes per value length.
CheckNils returns (conclusive comparison result, true) if at least one is nil return (false, false) if both are not nil and can both be safely dereferenced.
Concat concatenates bytes of byte-able objects.
CreateKVStreamFile create a new BinaryStreamFileWriter.
No description provided by the author
No description provided by the author
DumpToFile serializes iterator to the file in binary form.
No description provided by the author
GetProofGeneric returns generic proof path.
MustBytes most common way of serialization.
MustSize calculates byte size of the serializable object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NumEntries calculates number of key/value pair in the iterator.
OpenKVStreamFile opens existing file with key/value stream for reading.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RootCommitment computes root commitment from the root node of the trie represented as a NodeStore.
Size calculates byte size of the serializable object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnDumpFromFile restores dumped set of key/value pairs into the key/value writer.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NodeData contains all data trie node needs to compute commitment.
ProofGeneric represents a generic proof of inclusion or a maximal path in the trie which corresponds to the 'unpackedKey' The Ending indicates what represent the proof: it can be either 'proof of inclusion' of a unpackedKey/value Terminal, or a reorg code, which means what operation on the trie must be performed in order to update the unpackedKey/value pair.
No description provided by the author
RandStreamParams represents parameters of the RandStreamIterator.
Trie is an updatable trie implemented on top of the unpackedKey/value store.
TrieReader direct read-only access to trie.

# Interfaces

CommitmentModel abstracts 256+ Trie logic from the commitment logic/cryptography.
KVBatchedUpdater collects mutations in the buffer then flushes it at once.
KVIterator is an interface to iterate through a set of key/value pairs.
KVReader is a key/value reader.
KVStore is a compound interface.
KVStreamIterator is an interface to iterate stream In general, order is non-deterministic.
KVStreamWriter represents an interface to write a sequence of key/value pairs.
KVWriter is a key/value writer.
Node is a read-only interface to the 256+ trie node.
NodeStore is an interface to TrieReader to the trie as a set of TrieReader represented as unpackedKey/value pairs Two implementations: - TrieReader is a direct, non-cached TrieReader to unpackedKey/value storage - Trie implement a cached TrieReader.
Serializable is a common interface for serialization of commitment data.
TCommitment represents commitment to the terminal data.
VCommitment represents interface to the vector commitment.

# Type aliases

No description provided by the author
No description provided by the author