Struct oku_fs::fs::OkuFs

pub struct OkuFs { /* private fields */ }

An instance of an Oku file system.

The OkuFs struct is the primary interface for interacting with an Oku file system.

Implementations

impl OkuFs

pub async fn start() -> Result<OkuFs, Box<dyn Error + Send + Sync>>

Starts an instance of an Oku file system. In the background, an Iroh node is started, and the node’s address is periodically announced to the mainline DHT. If no author credentials are found on disk, new credentials are generated.

Returns

A running instance of an Oku file system.

pub async fn create_discovery_service( &self ) -> Result<ConcurrentDiscovery, Box<dyn Error + Send + Sync>>

Create a mechanism for discovering other nodes on the network given their IDs.

Returns

A discovery service for finding other node’s addresses given their IDs.

pub fn shutdown(self)

Shuts down the Oku file system.

pub async fn create_replica( &self ) -> Result<NamespaceId, Box<dyn Error + Send + Sync>>

Creates a new replica in the file system.

Returns

The ID of the new replica, being its public key.

pub async fn delete_replica( &self, namespace_id: NamespaceId ) -> Result<(), Box<dyn Error + Send + Sync>>

Deletes a replica from the file system.

Arguments

• namespace_id - The ID of the replica to delete.

pub async fn list_replicas( &self ) -> Result<Vec<NamespaceId>, Box<dyn Error + Send + Sync>>

Lists all replicas in the file system.

Returns

A list of all replicas in the file system.

pub async fn list_files( &self, namespace_id: NamespaceId ) -> Result<Vec<Entry>, Box<dyn Error + Send + Sync>>

Lists all files in a replica.

Arguments

• namespace_id - The ID of the replica to list files in.

Returns

A list of all files in the replica.

pub async fn create_or_modify_file( &self, namespace_id: NamespaceId, path: PathBuf, data: impl Into<Bytes> ) -> Result<Hash, Box<dyn Error + Send + Sync>>

Creates a file (if it does not exist) or modifies an existing file.

Arguments

• namespace_id - The ID of the replica containing the file to create or modify.

• path - The path of the file to create or modify.

• data - The data to write to the file.

Returns

The hash of the file.

pub async fn delete_file( &self, namespace_id: NamespaceId, path: PathBuf ) -> Result<usize, Box<dyn Error + Send + Sync>>

Deletes a file.

Arguments

• namespace_id - The ID of the replica containing the file to delete.

• path - The path of the file to delete.

Returns

The number of entries deleted in the replica, which should be 1 if the file was successfully deleted.

pub async fn read_file( &self, namespace_id: NamespaceId, path: PathBuf ) -> Result<Bytes, Box<dyn Error + Send + Sync>>

Reads a file.

Arguments

• namespace_id - The ID of the replica containing the file to read.

• path - The path of the file to read.

Returns

The data read from the file.

pub async fn move_file( &self, namespace_id: NamespaceId, from: PathBuf, to: PathBuf ) -> Result<(Hash, usize), Box<dyn Error + Send + Sync>>

Moves a file by copying it to a new location and deleting the original.

Arguments

• namespace_id - The ID of the replica containing the file to move.

• from - The path of the file to move.

• to - The path to move the file to.

Returns

A tuple containing the hash of the file at the new destination and the number of replica entries deleted during the operation, which should be 1 if the file at the original path was deleted.

pub async fn delete_directory( &self, namespace_id: NamespaceId, path: PathBuf ) -> Result<usize, Box<dyn Error + Send + Sync>>

Deletes a directory and all its contents.

Arguments

• namespace_id - The ID of the replica containing the directory to delete.

• path - The path of the directory to delete.

Returns

The number of entries deleted.

pub async fn respond_to_content_request( &self, request: PeerContentRequest ) -> Result<PeerContentResponse, Box<dyn Error + Send + Sync>>

Respond to requests for content from peers.

Arguments

• request - A request for content.

Returns

A response containing a ticket for the content.

pub async fn listen_for_document_ticket_fetch_requests( &self ) -> Result<(), Box<dyn Error + Send + Sync>>

Handles incoming requests for document tickets. This function listens for incoming connections from peers and responds to requests for document tickets.

pub async fn get_external_replica( &self, namespace_id: NamespaceId, path: Option<PathBuf>, partial: bool, verified: bool ) -> Result<(), Box<dyn Error + Send + Sync>>

Joins a swarm to fetch the latest version of a replica and save it to the local machine.

Arguments

• namespace_id - The ID of the replica to fetch.

• path - An optional path of requested files within the replica.

• partial - Whether to discover peers who claim to only have a partial copy of the replica.

• verified - Whether to discover peers who have been verified to have the replica.

pub async fn connect_to_relay( &self, relay_address: String ) -> Result<(), Box<dyn Error + Send + Sync>>

Connects to a relay to facilitate communication behind NAT. Upon connecting, the file system will send a list of all replicas to the relay. Periodically, the relay will request the list of replicas again using the same connection.

Arguments

• relay_address - The address of the relay to connect to.

Trait Implementations

impl Clone for OkuFs

fn clone(&self) -> OkuFs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OkuFs

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

Formats the value using the given formatter.