Struct holochain_types::dna::DnaFile

pub struct DnaFile { /* private fields */ }

Represents a full DNA, including DnaDef and WebAssembly bytecode.

Historical note: This struct was written before DnaBundle was introduced. This used to be our file representation of a full distributable DNA. That function has been superseded by DnaBundle, but we use this type widely, so there is simply a way to convert from DnaBundle to DnaFile.

TODO: Once we remove the InstallApp command which accepts a DnaFile, we should remove the Serialize impl on this type, and perhaps rename to indicate that this is simply a validated, fully-formed DnaBundle (i.e. all Wasms are bundled and immediately available, not remote.)

Implementations

impl DnaFile

pub async fn new(
    dna: DnaDef,
    wasm: impl IntoIterator<Item = DnaWasm>
) -> Result<Self, DnaError>

Construct a new DnaFile instance.

pub fn from_parts(dna: DnaDefHashed, code: WasmMap) -> Self

Construct a DnaFile from its constituent parts

pub fn dna(&self) -> &DnaDefHashed

The DnaDef along with its hash

pub fn dna_def(&self) -> &DnaDef

Just the DnaDef

pub fn dna_hash(&self) -> &DnaHash

The hash of the DnaDef

pub fn verify_hash(&self) -> Result<(), DnaError>

Verify that the DNA hash in the file matches the DnaDef

pub async fn from_file_content(data: &[u8]) -> Result<Self, DnaError>

👎 Deprecated:

remove after app bundles become standard; use DnaBundle instead

Load dna_file bytecode into this rust struct.

pub async fn with_properties(
    self,
    properties: SerializedBytes
) -> Result<Self, DnaError>

Transform this DnaFile into a new DnaFile with different properties and, hence, a different DnaHash.

pub async fn with_uid(self, uid: String) -> Result<Self, DnaError>

Transform this DnaFile into a new DnaFile with a different UID and, hence, a different DnaHash.

pub fn code(&self) -> &BTreeMap<WasmHash, DnaWasm>

The bytes of the WASM zomes referenced in the Dna portion.

pub fn get_wasm_for_zome(
    &self,
    zome_name: &ZomeName
) -> Result<&DnaWasm, DnaError>

Fetch the Webassembly byte code for a zome.

pub async fn to_file_content(&self) -> Result<Vec<u8>, DnaError>

👎 Deprecated:

remove after app bundles become standard; use DnaBundle instead

Render this dna_file as bytecode to send over the wire, or store in a file.

pub fn modify_phenotype(
    &self,
    uid: Uid,
    properties: YamlProperties
) -> DnaResult<Self>

Change the “phenotype” of this DNA – the UID and properties – while leaving the “genotype” of actual DNA code intact

Trait Implementations

impl Clone for DnaFile

fn clone(&self) -> DnaFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DnaFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DnaFile

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

Deserialize this value from the given Serde deserializer.

impl From<DnaFile> for (DnaDef, Vec<DnaWasm>)

fn from(dna_file: DnaFile) -> (DnaDef, Vec<DnaWasm>)

Converts to this type from the input type.

impl PartialEq<DnaFile> for DnaFile

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

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

fn ne(&self, other: &DnaFile) -> bool

This method tests for !=.

impl Serialize for DnaFile

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ DnaFile> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &DnaFile) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<DnaFile> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: DnaFile) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for DnaFile

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<DnaFile, SerializedBytesError>

Performs the conversion.

impl Eq for DnaFile

impl StructuralEq for DnaFile

impl StructuralPartialEq for DnaFile