Struct holochain_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: HashMap<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: HashMap<String, Zome>

An array of zomes associated with your holochain application.

Methods

impl Dna

pub fn new() -> Self

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

Examples

use holochain_dna::Dna;

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

pub fn from_json_str(dna: &str) -> Result<Self>

Create a new in-memory dna struct from a json string.

Examples

use holochain_dna::Dna;

let dna = Dna::from_json_str(r#"{
    "name": "MyTestApp"
}"#).expect("DNA should be valid");

assert_eq!("MyTestApp", dna.name);

pub fn to_json(&self) -> String

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

Examples

use holochain_dna::Dna;

let dna = Dna::new();
println!("json: {}", dna.to_json());

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

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

Examples

use holochain_dna::Dna;

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

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

Return a Zome

pub fn get_capability<'a>(     &'a self,     zome: &'a Zome,     capability_name: &str ) -> Option<&'a Capability>

Return a Zome's Capability from a Zome and a Capability 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 for a specified Capability

pub fn get_capability_with_zome_name(     &self,     zome_name: &str,     cap_name: &str ) -> Result<&Capability, DnaError>

Return a Zome's Capability from a Zome name and Capability name.

pub fn get_zome_name_for_entry_type(     &self,     entry_type_name: &str ) -> 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

Trait Implementations

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 Default for Dna

fn default() -> Self

Provide defaults for a dna object.

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 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 Debug for Dna

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

Formats the value using the given formatter.

impl ToEntry for Dna

fn to_entry(&self) -> Entry

fn from_entry(entry: &Entry) -> Self

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<'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.