Struct holochain_types::web_app::WebAppBundle

pub struct WebAppBundle(_);

A bundle of an AppBundle and a Web UI bound with it

Implementations

impl WebAppBundle

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

Construct from raw bytes

pub async fn web_ui_zip_bytes(&self) -> MrBundleResult<Cow<'_, ResourceBytes>>

Returns the bytes of the zip file containing the Web UI contained inside this WebAppBundle

pub async fn happ_bundle(&self) -> MrBundleResult<AppBundle>

Returns the hApp bundle contained inside this WebAppBundle

Methods from Deref<Target = Bundle<WebAppManifest>>

pub fn manifest(&self) -> &M

Accessor for the Manifest

pub async fn write_to_file(
    &'_ self,
    path: &'_ Path
) -> Result<(), MrBundleError>

Write a Bundle to a file

pub async fn resolve(
    &'_ self,
    location: &'_ Location
) -> 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
) -> 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
) -> Result<HashMap<Location, Vec<u8, Global>, RandomState>, MrBundleError>

Resolve all resources, but with fully owned references

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

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
) -> 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<WebAppManifest>> for WebAppBundle

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

Performs the conversion.

impl Borrow<Bundle<WebAppManifest>> for WebAppBundle

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

Immutably borrows from an owned value.

impl Debug for WebAppBundle

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

Formats the value using the given formatter.

impl Deref for WebAppBundle

type Target = Bundle<WebAppManifest>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for WebAppBundle

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

Deserialize this value from the given Serde deserializer.

impl From<Bundle<WebAppManifest>> for WebAppBundle

fn from(original: Bundle<WebAppManifest>) -> WebAppBundle

Performs the conversion.

impl Serialize for WebAppBundle

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

Serialize this value into the given Serde serializer.