Struct noosphere_cli::paths::SpherePaths

pub struct SpherePaths { /* private fields */ }

SpherePaths record the critical paths within a sphere workspace as rendered to a typical file system. It is used to ensure that we read from and write to consistent locations when rendering and updating a sphere as files on disk.

NOTE: We use hashes to represent internal paths for a couple of reasons, both related to Windows filesystem limitations:

1. Windows filesystem, in the worst case, only allows 260 character-long paths
2. Windows does not allow various characters (e.g., ‘:’) in file paths, and there is no option to escape those characters

Hashing eliminates problem 2 and improves conditions so that we are more likely to avoid problem 1.

See: https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry See also: https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions

Implementations

impl SpherePaths

pub async fn intialize(root: &Path) -> Result<Self>

Initialize SpherePaths for a given root path. This has the effect of creating the “private” directory hierarchy (starting from SPHERE_DIRECTORY inside the root).

pub fn discover(from: Option<&Path>) -> Option<Self>

Attempt to discover an existing workspace root by traversing ancestor directories until one is found that contains a SPHERE_DIRECTORY.

pub fn version(&self) -> &Path

The path to the root version file within the local SPHERE_DIRECTORY

pub fn identity(&self) -> &Path

The path to the root identity file within the local SPHERE_DIRECTORY

pub fn depth(&self) -> &Path

The path to the root depth file within the local SPHERE_DIRECTORY

pub fn root(&self) -> &Path

The path to the workspace root directory, which contains a SPHERE_DIRECTORY

pub fn sphere(&self) -> &Path

The path to the SPHERE_DIRECTORY within the workspace root

pub fn peers(&self) -> &Path

The path the directory within the SPHERE_DIRECTORY that contains rendered peer spheres

pub fn slug(&self, slug: &str) -> Result<PathBuf>

Given a slug, get a path where we may write a reverse-symlink to a file system file that is a rendered equivalent of the content that can be found at that slug. The slug’s UTF-8 bytes are base64-encoded so that certain characters that are allowed in slugs (e.g., ‘/’) do not prevent us from creating the symlink.

pub fn peer(&self, peer: &Did, version: &Cid) -> PathBuf

Given a peer Did and sphere version Cid, get a path where the that peer’s sphere at the given version ought to be rendered. The path will be unique and deterministic far a given combination of Did and Cid.

pub fn peer_hard_link(&self, memo_cid: &Cid) -> PathBuf

Given a Cid for a peer’s memo, get a path to a file where the content referred to by that memo ought to be written.

pub fn root_hard_link(&self, slug: &str, memo: &MemoIpld) -> Result<PathBuf>

Given a slug and a MemoIpld referring to some content in the local sphere, get a path to a file where the content referred to by the MemoIpld ought to be rendered (including file extension).

pub fn peer_soft_link( &self, peer: &Did, version: &Cid, slug: &str, memo: &MemoIpld ) -> Result<PathBuf>

Similar to SpherePaths::root_hard_link but for a peer given by Did and sphere version Cid.

pub fn file(&self, base: &Path, slug: &str, memo: &MemoIpld) -> Result<PathBuf>

Given a base path, a slug and a MemoIpld, get the full file path (including inferred file extension) for a file that corresponds to the given MemoIpld.

Trait Implementations

impl Clone for SpherePaths

fn clone(&self) -> SpherePaths

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpherePaths

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

Formats the value using the given formatter.