Struct holochain_types::web_app::WebAppBundle
source · [−]pub struct WebAppBundle(_);
Expand description
A bundle of an AppBundle and a Web UI bound with it
Implementations
sourceimpl WebAppBundle
impl WebAppBundle
sourcepub fn decode(bytes: &[u8]) -> MrBundleResult<Self>
pub fn decode(bytes: &[u8]) -> MrBundleResult<Self>
Construct from raw bytes
sourcepub async fn web_ui_zip_bytes(&self) -> MrBundleResult<Cow<'_, ResourceBytes>>
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
sourcepub async fn happ_bundle(&self) -> MrBundleResult<AppBundle>
pub async fn happ_bundle(&self) -> MrBundleResult<AppBundle>
Returns the hApp bundle contained inside this WebAppBundle
Methods from Deref<Target = Bundle<WebAppManifest>>
sourcepub async fn write_to_file(
&self,
path: &Path
) -> impl Future<Output = Result<(), MrBundleError>>
pub async fn write_to_file(
&self,
path: &Path
) -> impl Future<Output = Result<(), MrBundleError>>
Write a Bundle to a file
sourcepub async fn resolve(
&self,
location: &Location
) -> impl Future<Output = Result<Cow<'_, Vec<u8, Global>>, MrBundleError>>
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
sourcepub async fn resolve_all(
&self
) -> impl Future<Output = Result<HashMap<Location, Cow<'_, Vec<u8, Global>>, RandomState>, MrBundleError>>
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.
sourcepub async fn resolve_all_cloned(
&self
) -> impl Future<Output = Result<HashMap<Location, Vec<u8, Global>, RandomState>, MrBundleError>>
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
sourcepub fn bundled_resources(&self) -> &BTreeMap<PathBuf, Vec<u8, Global>, Global>
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
sourcepub fn encode(&self) -> Result<Vec<u8, Global>, MrBundleError>
pub fn encode(&self) -> Result<Vec<u8, Global>, MrBundleError>
An arbitrary and opaque encoding of the bundle data into a byte array
sourcepub fn find_root_dir(&self, path: &Path) -> Result<PathBuf, MrBundleError>
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.
sourcepub async fn unpack_yaml(
&self,
base_path: &Path,
force: bool
) -> impl Future<Output = Result<(), MrBundleError>>
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
sourceimpl AsRef<Bundle<WebAppManifest>> for WebAppBundle
impl AsRef<Bundle<WebAppManifest>> for WebAppBundle
sourcefn as_ref(&self) -> &Bundle<WebAppManifest>
fn as_ref(&self) -> &Bundle<WebAppManifest>
sourceimpl Borrow<Bundle<WebAppManifest>> for WebAppBundle
impl Borrow<Bundle<WebAppManifest>> for WebAppBundle
sourcefn borrow(&self) -> &Bundle<WebAppManifest>
fn borrow(&self) -> &Bundle<WebAppManifest>
sourceimpl Debug for WebAppBundle
impl Debug for WebAppBundle
sourceimpl Deref for WebAppBundle
impl Deref for WebAppBundle
sourceimpl<'de> Deserialize<'de> for WebAppBundle
impl<'de> Deserialize<'de> for WebAppBundle
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl From<Bundle<WebAppManifest>> for WebAppBundle
impl From<Bundle<WebAppManifest>> for WebAppBundle
sourcefn from(original: Bundle<WebAppManifest>) -> WebAppBundle
fn from(original: Bundle<WebAppManifest>) -> WebAppBundle
sourceimpl Serialize for WebAppBundle
impl Serialize for WebAppBundle
Auto Trait Implementations
impl RefUnwindSafe for WebAppBundle
impl Send for WebAppBundle
impl Sync for WebAppBundle
impl Unpin for WebAppBundle
impl UnwindSafe for WebAppBundle
Blanket Implementations
impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
impl<T> FutureExt for T
impl<T> FutureExt for T
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.