pub struct OriginFileSystem { /* private fields */ }Expand description
An crate::origin::Origin backed by a directory on disk, via tokio::fs. ObjectIds
are relative paths resolved against root.
§Examples
use nimbus_vault::{
object::{Metadata, Object, ObjectId},
origin::{Origin, fs::OriginFileSystem},
};
let dir = tempfile::tempdir()?;
let origin = OriginFileSystem::new(dir.path().to_path_buf());
let mut file = Object::Leaf {
name: "notes.txt".to_string(),
id: ObjectId::from("notes.txt"),
meta: Metadata::new(),
};
origin.put(&mut file, &ObjectId::from("")).await?; // creates the file
assert!(dir.path().join("notes.txt").is_file());
let fetched = origin.get(&ObjectId::from("notes.txt")).await?;
assert!(matches!(fetched, Object::Leaf { .. }));Declaratively, via [origin_config] in a vault’s TOML config:
[origin_config]
type = "fs"
root = "/srv/data"Implementations§
Trait Implementations§
Source§impl Origin for OriginFileSystem
impl Origin for OriginFileSystem
Source§fn get<'life0, 'life1, 'async_trait>(
&'life0 self,
id: &'life1 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<Object>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn get<'life0, 'life1, 'async_trait>(
&'life0 self,
id: &'life1 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<Object>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Fetches
id’s metadata as an Object.Source§fn list<'life0, 'life1, 'async_trait>(
&'life0 self,
id: &'life1 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<Vec<Object>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn list<'life0, 'life1, 'async_trait>(
&'life0 self,
id: &'life1 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<Vec<Object>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Lists
id’s children (for a Branch/Root id).Source§fn fetch<'life0, 'life1, 'async_trait>(
&'life0 self,
id: &'life1 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<ByteStream>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn fetch<'life0, 'life1, 'async_trait>(
&'life0 self,
id: &'life1 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<ByteStream>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Streams
id’s payload.Source§fn put<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
object: &'life1 mut Object,
destination: &'life2 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<Object>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn put<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
object: &'life1 mut Object,
destination: &'life2 ObjectId,
) -> Pin<Box<dyn Future<Output = VaultResult<Object>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Writes
object’s metadata (without payload) to the origin.Auto Trait Implementations§
impl Freeze for OriginFileSystem
impl RefUnwindSafe for OriginFileSystem
impl Send for OriginFileSystem
impl Sync for OriginFileSystem
impl Unpin for OriginFileSystem
impl UnsafeUnpin for OriginFileSystem
impl UnwindSafe for OriginFileSystem
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more