Struct Tree 

pub struct Tree {
    pub directory_map: TreePathMap,
    pub archive: DualArchive,
    pub dweb_settings: DwebSettings,
}

Tree is a directory tree of files stored on Autonomi. It supports optional metadata for a website which is stored in the Autonomi Archive as a special file.

See also, History which provides a persistent history of all versions of the tree or website which have been stored.

Fields

directory_map: TreePathMap

Map using directory as key:

archive: DualArchive

Holds the Autonomi archive type for serialisation

dweb_settings: DwebSettings

Optional settings for dweb or third party apps. These are stored as a JSON formatted file in the Archive, updated whenever the Tree is stored on or retrieved from the network.

Implementations

impl Tree

Work in progress and subject to breaking changes TODO consider how to handle use as a virtual file store (see comments above this in the code)

pub async fn from_datamap_or_address( client: &DwebClient, datamap_chunk: Option<DataMapChunk>, archive_address: Option<ArchiveAddress>, ) -> Result<Tree>

Get an archive from the network and use it to create a new Tree

pub async fn from_datamap_chunk( client: &DwebClient, datamap_chunk: DataMapChunk, ) -> Result<Tree>

Get an archive from the network and use it to create a new Tree

pub async fn from_archive_address( client: &DwebClient, archive_address: ArchiveAddress, ) -> Result<Tree>

Get an archive from the network and use it to create a new Tree

pub async fn from_public_archive( client: &DwebClient, public_archive: PublicArchive, ) -> Tree

Initialise from an PublicArchive

If the archive contains a DwebSettings file this will be read from the network

pub async fn from_private_archive( client: &DwebClient, private_archive: PrivateArchive, ) -> Tree

Initialise from an PrivateArchive

If the archive contains a DwebSettings file this will be read from the network

pub async fn from_dual_archive( client: &DwebClient, archive: DualArchive, ) -> Tree

Initialise from a DualArchive

If the archive contains a DwebSettings file this will be read from the network

Check the value of DualArchive.dweb_type to determine the type or archive. On failure it will be DwebType::Uknown

pub async fn history_lookup_file( history: &mut History<Tree>, resource_path: &String, as_website: bool, version: Option<u64>, ) -> Result<(String, String, Option<String>), StatusCode>

Looks up a file or website resource in a version of a History

First gets a Tree version, using cached data if held by the history If version is None attempts obtain the default (most recent version)

as_website controls special handling for a website. See lookup_file()

If found, returns a tuple: (datamap_chunk: String, data_address: String, content_type: Option)

Only one of datamap_chunk and data_address will be a hex encoded string, the other empty.

pub fn lookup_file( &self, resource_path: &String, as_website: bool, ) -> Result<(String, String, Option<String>), StatusCode>

Look up a canonicalised file path (which must begin with ‘/’) with special handling for websites.

If the path ends with ‘/’ or no file matches a directory is assumed and handling depends on the value of as_website.

if as_website is false the path must be an exact match for a file.

If as_website is true, an exact path match is not always required. For directories it will look for a default index file based on any dweb settings. It will also return a default for ‘/faviocon.ico’ if not matched.

If found, returns a tuple: (datamap_chunk: String, data_address: String, content_type: Option)

Only one of datamap_chunk and data_address will be a hex encoded string, the other empty.

On error, returns a suitable status code??? TODO

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Trove<Tree> for Tree

fn to_bytes(directory_tree: &Tree) -> Result<Bytes>

Serialise as PrivateArchive

A PrivateArchive is used in preference to PublicArchive even for public data. See dweb::archive::DualArchive for an explanation.

fn trove_type() -> DataAddress

async fn from_bytes(client: &DwebClient, bytes: Bytes) -> Result<Tree>