Module holochain_types::dna

dna is a library for working with holochain dna files/entries.

It includes utilities for representing dna structures in memory, as well as serializing and deserializing dna, mainly to json format.

Re-exports

• pub use error::DnaError;

Modules

• encode
  Include nice string encoding methods and From impls
• error
  Holochain DnaError type.
• fixt
• hash_type
  Defines the prefixes for the various HashTypes, as well as the traits which unify them
• wasm
  crate::dna::wasm is a module for managing webassembly code

Macros

• assert_length
  Helper for ensuring the the proper number of bytes is used in various situations
• impl_hashable_content
  A default HashableContent implementation, suitable for content which is already TryInto<SerializedBytes>, and uses a PrimitiveHashType

Structs

• CompositeHashConversionError
  Error converting a composite hash into a subset composite hash, due to type mismatch
• CoordinatorBundle
  A bundle of coordinator zomes.
• CoordinatorManifest
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Coordinator zomes.
• DnaBundle
  A bundle of Wasm zomes, respresented as a file.
• DnaFile
  Represents a full DNA, including DnaDef and WebAssembly bytecode.
• DnaManifestCurrent
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. The structure of data that goes in the DNA bundle manifest “dna.yaml”.
• DnaManifestCurrentBuilder
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Builder for DnaManifestV1.
• DnaManifestV1
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. The structure of data that goes in the DNA bundle manifest “dna.yaml”.
• DnaManifestV1Builder
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Builder for DnaManifestV1.
• EntryDefBufferKey
  Key for the EntryDef buffer
• EntryHashes
  A newtype for a collection of EntryHashes, needed for some wasm return types.
• HashConversionError
  Error converting a composite hash into a primitive one, due to type mismatch
• HoloHash
  A HoloHash contains a vector of 36 bytes representing a 32-byte blake2b hash plus 4 bytes representing a DHT location. It also contains a zero-sized type which specifies what it is a hash of.
• HoloHashB64
  A wrapper around HoloHash that Serializes into a base64 string rather than a raw byte array.
• HoloHashed
  Represents some piece of content along with its hash representation, so that hashes need not be calculated multiple times. Provides an easy constructor which consumes the content.
• IntegrityManifest
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Manifest for all items that will change the DnaHash.
• IntegrityManifestBuilder
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Builder for IntegrityManifest.
• ValidatedDnaManifest
  A dna manifest that has been successfully validated.
• WasmMap
  Wasms need to be an ordered map from WasmHash to a wasm::DnaWasm
• ZomeDependency
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Manifest for integrity zomes that another zome depends on.
• ZomeManifest
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Manifest for an individual Zome

Enums

• AnyDhtHashPrimitive
  The primitive hash types represented by this composite hash
• AnyLinkableHashPrimitive
  The primitive hash types represented by this composite hash
• DnaManifest
  The enum which encompasses all versions of the DNA manifest, past and present.
• HashableContentBytes
  HashableContent can be expressed as “content”, or “prehashed”, which affects how a HoloHashed type will be constructed from it.

Constants

• HOLO_HASH_CORE_LEN
  Length of the core bytes (32)
• HOLO_HASH_FULL_LEN
  Length of the full HoloHash bytes (39 = 3 + 32 + 4)
• HOLO_HASH_LOC_LEN
  Length of the location bytes (4)
• HOLO_HASH_PREFIX_LEN
  Length of the prefix bytes (3)
• HOLO_HASH_UNTYPED_LEN
  Length of the core bytes + the loc bytes (36 = 32 + 4), i.e. everything except the type prefix
• MAX_HASHABLE_CONTENT_LEN
  The maximum size to hash synchronously. Anything larger than this will take too long to hash within a single tokio context

Traits

• DnaStore
  A store of DnaFiles which can be accessed by DnaHash.
• HasHash
  Anything which has an owned HoloHashOf.
• HashType
  Every HoloHash is generic over HashType. Additionally, every HashableContent has an associated HashType. The HashType is the glue that binds together HashableContent with its hash.
• HashableContent
  Any implementor of HashableContent may be used in a HoloHashed to pair data with its HoloHash representation. It also has an associated HashType.
• HashableContentExtAsync
  Adds convenience methods for constructing HoloHash and HoloHashed from some HashableContent
• HashableContentExtSync
  Adds convenience methods for constructing HoloHash and HoloHashed from some HashableContent
• PrimitiveHashType
  A PrimitiveHashType is one with a multihash prefix. In contrast, a non-primitive hash type could be one of several primitive types, e.g. an AnyDhtHash can represent one of three primitive types.

Functions

• blake2b_256
  internal compute a 32 byte blake2b hash
• holo_hash_decode
  internal PARSE for holo hash REPR
• holo_hash_decode_unchecked
  internal PARSE for holo hash REPR
• holo_hash_encode
  internal REPR for holo hash

Type Aliases

• ActionHash
  The hash of an action
• ActionHashB64
  Base64-ready version of ActionHash
• AgentPubKey
  An Agent public signing key. Not really a hash, more of an “identity hash”.
• AgentPubKeyB64
  Base64-ready version of AgentPubKey
• AnyDhtHash
  The hash of anything referrable in the DHT. This is a composite of either an EntryHash or a ActionHash
• AnyDhtHashB64
  Base64-ready version of AnyDhtHash
• AnyLinkableHash
  The hash of anything linkable.
• AnyLinkableHashB64
  Base64-ready version of AnyLinkableHash
• DhtOpHash
  The hash of a DhtOp’s “unique form” representation
• DhtOpHashB64
  Base64-ready version of DhtOpHash
• DnaHash
  The hash of a DnaDef
• DnaHashB64
  Base64-ready version of DnaHash
• EntryHash
  The hash of an Entry.
• EntryHashB64
  Base64-ready version of EntryHash
• ExternalHash
  The hash of some external data that can’t or doesn’t exist on the DHT.
• ExternalHashB64
  Base64-ready version of ExternalHash
• HoloHashOf
  A convenience type, for specifying a hash by HashableContent rather than by its HashType
• NetIdHash
  The hash of a network ID
• NetIdHashB64
  Base64-ready version of NetIdHash
• OpBasis
  Alias for AnyLinkableHash. This hash forms the notion of the “basis hash” of an op.
• WasmHash
  The hash of some wasm bytecode
• WasmHashB64
  Base64-ready version of WasmHash
• ZomeCallSigningKey
  A public key of a pair of signing keys for signing zome calls.
• ZomeLocation
  Re-export the current version. When creating a new version, just re-export the new version, and update the code accordingly. Alias for a suitable representation of zome location