Struct noosphere_cli::native::workspace::Workspace

pub struct Workspace { /* private fields */ }

A Workspace represents the root directory where sphere data is or will be kept, and exposes core operations that commands need in order to operate on that directory. Among other things, it holds a singleton SphereContext so that we don’t constantly open the local SphereDb multiple times in the space of a single command. It also offers a convenient entrypoint to access KeyStorage for the local platform.

Implementations

impl Workspace

pub async fn sphere_context(&self) -> Result<Arc<Mutex<CliSphereContext>>>

Get a mutex-guarded reference to the SphereContext for the current workspace

pub async fn db(&self) -> Result<SphereDb<NativeStorage>>

Get an owned referenced to the SphereDb that backs the local sphere. Note that this will initialize the SphereContext if it has not been already.

pub fn key_storage(&self) -> &InsecureKeyStorage

Get the KeyStorage that is supported on the current platform

pub fn root_directory(&self) -> &Path

The root directory is the path to the folder that contains a .sphere directory (or will, after the sphere is initialized)

pub fn sphere_directory(&self) -> &Path

The path to the .sphere directory within the root directory

pub fn key_directory(&self) -> &Path

This directory contains keys that are stored using an insecure, strait- to-disk storage mechanism

pub async fn sphere_identity(&self) -> Result<Did>

Gets the Did of the sphere

pub async fn get_file_content_changes<S: Store>(
    &self,
    new_blocks: &mut S
) -> Result<Option<(Content, ContentChanges)>>

Produces a manifest of changes (added, updated and removed) derived from the current state of the workspace

pub async fn read_file_content<S: BlockStore>(
    &self,
    store: &mut S
) -> Result<Content>

Read the local content of the workspace in its entirety. This includes files that have not yet been saved to the sphere. All files are chunked into blocks, and those blocks are persisted to the provided store. TODO(#105): We may want to change this to take an optional list of paths to consider, and allow the user to rely on their shell for glob filtering

pub async fn render(&self) -> Result<()>

Reads the latest local version of the sphere and renders its contents to files in the workspace. Note that this will overwrite any existing files in the workspace.

pub async fn infer_content_type(&self, extension: &str) -> Result<ContentType>

Given a file extension, infer its mime

pub async fn infer_file_extension(
    &self,
    content_type: ContentType
) -> Option<String>

Given a mime, infer its file extension

pub async fn key(&self) -> Result<Ed25519KeyMaterial>

Get the key material (with both verification and signing capabilities) for the locally configured author key.

pub async fn counterpart_identity(&self) -> Result<Did>

Get the configured counterpart sphere’s identity

pub async fn authorization(&self) -> Result<Authorization>

Attempts to read the locally stored authorization that enables the key to operate on this sphere; the returned authorization may be represented as either a UCAN or the CID of a UCAN

pub async fn gateway_url(&self) -> Result<Url>

Get the configured gateway URL for the local workspace

pub fn new(
    current_working_directory: &Path,
    noosphere_directory: Option<&Path>
) -> Result<Self>

pub fn temporary() -> Result<(Self, (TempDir, TempDir))>

Configure a workspace automatically by creating temporary directories on the file system and initializing it with their paths

Trait Implementations

impl<'a> From<&'a Workspace> for Config<'a>

fn from(workspace: &'a Workspace) -> Self

Converts to this type from the input type.