Skip to main content

OriginFileSystem

Struct OriginFileSystem 

Source
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§

Source§

impl OriginFileSystem

Source

pub fn new(root: PathBuf) -> Self

Builds an OriginFileSystem rooted at root; every ObjectId is resolved relative to it.

Trait Implementations§

Source§

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,

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,

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,

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,

Writes object’s metadata (without payload) to the origin.
Source§

fn send<'life0, 'life1, 'async_trait>( &'life0 self, object: &'life1 Object, payload: ByteStream, ) -> Pin<Box<dyn Future<Output = VaultResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Streams payload to the origin as object’s contents.
Source§

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 ObjectId, ) -> Pin<Box<dyn Future<Output = VaultResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deletes id from the origin.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more