Struct holochain_core_types::dna::Dna

pub struct Dna {
    pub name: String,
    pub description: String,
    pub version: String,
    pub uuid: String,
    pub dna_spec_version: String,
    pub properties: Value,
    pub zomes: BTreeMap<String, Zome>,
}

Represents the top-level holochain dna object.

Fields

name: String

The top-level "name" of a holochain application.

description: String

The top-level "description" of a holochain application.

version: String

The semantic version of your holochain application.

uuid: String

A unique identifier to distinguish your holochain application.

dna_spec_version: String

Which version of the holochain dna spec does this represent?

properties: Value

Any arbitrary application properties can be included in this object.

zomes: BTreeMap<String, Zome>

An array of zomes associated with your holochain application.

Implementations

impl Dna

pub fn new() -> Self

Create a new in-memory dna structure with some default values.

Examples

use holochain_core_types::dna::Dna;

let dna = Dna::new();
assert_eq!("", dna.name);

pub fn to_json_pretty(&self) -> Result<String>

Generate a pretty-printed json string from an in-memory dna struct.

Examples

use holochain_core_types::dna::Dna;

let dna = Dna::new();
println!("json: {}", dna.to_json_pretty().expect("DNA should serialize"));

pub fn get_zome(&self, zome_name: &str) -> Result<&Zome, DnaError>

Return a Zome

pub fn get_trait<'a>(
    &'a self,
    zome: &'a Zome,
    trait_name: &str
) -> Option<&'a TraitFns>

Return a Zome's TraitFns from a Zome and a Trait name.

pub fn get_function_with_zome_name(
    &self,
    zome_name: &str,
    fn_name: &str
) -> Result<&FnDeclaration, DnaError>

Return a Zome Function declaration from a Zome name and Function name.

pub fn get_wasm_from_zome_name<T: Into<String>>(
    &self,
    zome_name: T
) -> Option<&DnaWasm>

Find a Zome and return it's WASM bytecode

pub fn get_trait_fns_with_zome_name(
    &self,
    zome_name: &str,
    trait_name: &str
) -> Result<&TraitFns, DnaError>

Return a Zome's Trait functions from a Zome name and trait name.

pub fn get_zome_name_for_app_entry_type(
    &self,
    app_entry_type: &AppEntryType
) -> Option<String>

Return the name of the zome holding a specified app entry_type

pub fn get_entry_type_def(&self, entry_type_name: &str) -> Option<&EntryTypeDef>

Return the entry_type definition of a specified app entry_type

pub fn multihash(&self) -> Result<Vec<u8>, HolochainError>

pub fn get_required_bridges(&self) -> Vec<Bridge>

pub fn verify(&self) -> HcResult<()>

Trait Implementations

impl AddressableContent for Dna

fn content(&self) -> Content

the Content that would be stored in a ContentAddressableStorage the default implementation covers anything that implements From for JsonString

fn try_from_content(content: &Content) -> JsonResult<Self>

restore/deserialize the original struct/type from serialized Content the default implementation covers anything that implements From for Foo

fn address(&self) -> HashString

the Address the Content would be available at once stored in a ContentAddressableStorage default implementation is provided as hashing Content with sha256 the default implementation should cover most use-cases it is critical that there are no hash collisions across all stored AddressableContent it is recommended to implement an "address space" prefix for address algorithms that don't offer strong cryptographic guarantees like sha et. al.

impl Clone for Dna

fn clone(&self) -> Dna

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Dna

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Dna

fn default() -> Self

Provide defaults for a dna object.

impl<'de> Deserialize<'de> for Dna

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Dna

impl<'a> From<&'a Dna> for JsonString

fn from(v: &Dna) -> JsonString

Performs the conversion.

impl From<Dna> for JsonString

fn from(v: Dna) -> JsonString

Performs the conversion.

impl Hash for Dna

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Dna> for Dna

fn eq(&self, other: &Dna) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Dna

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a JsonString> for Dna

type Error = JsonError

The type returned in the event of a conversion error.

fn try_from(json_string: &JsonString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsonString> for Dna

type Error = JsonError

The type returned in the event of a conversion error.

fn try_from(json_string: JsonString) -> Result<Self, Self::Error>

Performs the conversion.