Struct holochain_types::dna::DnaBundle

pub struct DnaBundle(_);

A bundle of Wasm zomes, respresented as a file.

Implementations

impl DnaBundle

pub fn new(
    manifest: ValidatedDnaManifest,
    resources: Vec<(PathBuf, Vec<u8>)>,
    root_dir: PathBuf
) -> DnaResult<Self>

Constructor

pub async fn into_dna_file(
    self,
    modifiers: DnaModifiersOpt
) -> DnaResult<(DnaFile, DnaHash)>

Convert to a DnaFile, and return what the hash of the Dna would have been without the provided modifier overrides

pub fn decode(bytes: &[u8]) -> DnaResult<Self>

Construct from raw bytes

pub async fn read_from_file(path: &Path) -> DnaResult<Self>

Read from a bundle file

pub fn to_dna_def(
    &self,
    integrity_zomes: IntegrityZomes,
    coordinator_zomes: CoordinatorZomes,
    modifiers: DnaModifiersOpt
) -> DnaResult<(DnaDefHashed, DnaHash)>

Convert to a DnaDef

pub async fn from_dna_file(dna_file: DnaFile) -> DnaResult<Self>

Build a bundle from a DnaFile. Useful for tests.

Methods from Deref<Target = Bundle<ValidatedDnaManifest>>

pub fn manifest(&self) -> &M

Accessor for the Manifest

pub async fn write_to_file(
    &self,
    path: &Path
) -> impl Future<Output = Result<(), MrBundleError>>

Write a Bundle to a file

pub async fn resolve(
    &self,
    location: &Location
) -> impl Future<Output = Result<Cow<'_, Vec<u8, Global>>, MrBundleError>>

Retrieve the bytes for a resource at a Location, downloading it if necessary

pub async fn resolve_all(
    &self
) -> impl Future<Output = Result<HashMap<Location, Cow<'_, Vec<u8, Global>>, RandomState>, MrBundleError>>

Return the full set of resources specified by this bundle’s manifest. References to bundled resources can be returned directly, while all others will be fetched from the filesystem or the network.

pub async fn resolve_all_cloned(
    &self
) -> impl Future<Output = Result<HashMap<Location, Vec<u8, Global>, RandomState>, MrBundleError>>

Resolve all resources, but with fully owned references

pub fn bundled_resources(&self) -> &BTreeMap<PathBuf, Vec<u8, Global>, Global>

Access the map of resources included in this bundle Bundled resources are also accessible via resolve or resolve_all, but using this method prevents a Clone

pub fn encode(&self) -> Result<Vec<u8, Global>, MrBundleError>

An arbitrary and opaque encoding of the bundle data into a byte array

pub fn find_root_dir(&self, path: &Path) -> Result<PathBuf, MrBundleError>

Given that the Manifest is located at the given absolute path, find the absolute root directory for the “unpacked” Bundle directory. Useful when “imploding” a directory into a bundle to determine the default location of the generated Bundle file.

This will only be different than the Manifest path itself if the Manifest::path impl specifies a nested path.

Will return None if the path does not actually end with the manifest relative path, meaning that either the manifest file is misplaced within the unpacked directory, or an incorrect path was supplied.

pub async fn unpack_yaml(
    &self,
    base_path: &Path,
    force: bool
) -> impl Future<Output = Result<(), MrBundleError>>

Create a directory which contains the manifest as a YAML file, and each resource written to its own file (as raw bytes) The paths of the resources are specified by the paths of the bundle, and the path of the manifest file is specified by the Manifest::path trait method implementation of the M type.

Trait Implementations

impl AsRef<Bundle<ValidatedDnaManifest>> for DnaBundle

fn as_ref(&self) -> &Bundle<ValidatedDnaManifest>

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Bundle<ValidatedDnaManifest>> for DnaBundle

fn borrow(&self) -> &Bundle<ValidatedDnaManifest>

Immutably borrows from an owned value.

impl Debug for DnaBundle

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

Formats the value using the given formatter.

impl Deref for DnaBundle

type Target = Bundle<ValidatedDnaManifest>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for DnaBundle

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

Deserialize this value from the given Serde deserializer.

impl From<Bundle<ValidatedDnaManifest>> for DnaBundle

fn from(original: Bundle<ValidatedDnaManifest>) -> DnaBundle

Converts to this type from the input type.

impl PartialEq<DnaBundle> for DnaBundle

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DnaBundle

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

Serialize this value into the given Serde serializer.

impl TryFrom<&DnaBundle> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<DnaBundle> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SerializedBytes> for DnaBundle

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for DnaBundle

impl StructuralEq for DnaBundle

impl StructuralPartialEq for DnaBundle