FileStorage

Struct FileStorage 

Source
pub struct FileStorage<B: BlobStore> {
    blob_client: BlobClient,
    remote_blob_service: Arc<B>,
    compression_config: CompressionConfig,
}
Expand description

High-level file storage client that encrypts files and stores them as blobs

Fields§

§blob_client: BlobClient§remote_blob_service: Arc<B>§compression_config: CompressionConfig

Implementations§

Source§

impl<B: BlobStore> FileStorage<B>

Source

pub async fn new( blob_storage_path: &Path, remote_blob_service: Arc<B>, compression_config: CompressionConfig, ) -> Result<Self>

Create a new file storage client with remote blob service and custom compression

Source

pub async fn store_file(&self, file_path: &Path) -> Result<FileRef>

Store a file by reading from disk, encrypting, and storing in blob storage

This method:

  1. Reads the file from the provided path
  2. Encrypts the content using convergent encryption
  3. Stores the encrypted data in the blob store
  4. Returns metadata needed to retrieve the file later
§Arguments
  • file_path - Path to the file to store
§Returns

FileRef containing the blob hash, encryption info, and metadata

§Example
let temp_dir = tempdir()?;
let storage = FileStorage::new(temp_dir.path()).await?;

let file_path = Path::new("/path/to/document.pdf");
let stored_info = storage.store_file(file_path).await?;

println!("File stored with blob hash: {}", stored_info.blob_hash);
Source

pub async fn store_data( &self, data: &[u8], reference_name: &str, content_type: Option<String>, ) -> Result<FileRef>

Store raw data (not from a file) with encryption and blob storage

This method allows storing arbitrary data without reading from disk.

§Arguments
  • data - The raw data to store
  • reference_name - A reference name for the data (used in metadata)
  • content_type - Optional content type for metadata
§Returns

FileRef containing the blob hash, encryption info, and metadata

Source

pub async fn retrieve_file(&self, stored_info: &FileRef) -> Result<Vec<u8>>

Retrieve a file from storage and decrypt it

This method:

  1. Retrieves the encrypted data from blob storage using the hash
  2. Decrypts the data using the provided encryption info
  3. Returns the original file content
§Arguments
  • stored_info - Metadata from when the file was stored
§Returns

The original file content as bytes

§Example
let temp_dir = tempdir()?;
let storage = FileStorage::new(temp_dir.path()).await?;

// Assume we have stored_info from a previous store_file call

let file_content = storage.retrieve_file(&stored_info).await?;
println!("Retrieved {} bytes", file_content.len());
Source

pub async fn has_file(&self, stored_info: &FileRef) -> Result<bool>

Check if a file exists in storage

§Arguments
  • stored_info - Metadata from when the file was stored
§Returns

true if the file exists in storage, false otherwise

Source

pub async fn retrieve_file_to_disk( &self, stored_info: &FileRef, output_path: &Path, ) -> Result<()>

Save retrieved file content to disk

This is a convenience method that combines retrieve_file with writing to disk.

§Arguments
  • stored_info - Metadata from when the file was stored
  • output_path - Path where to write the retrieved file
§Example
let temp_dir = tempdir()?;
let storage = FileStorage::new(temp_dir.path()).await?;


let output_path = Path::new("/tmp/retrieved_file.txt");
storage.retrieve_file_to_disk(&stored_info, output_path).await?;
Source

pub fn blob_client(&self) -> &BlobClient

Get the underlying blob client for advanced operations

Trait Implementations§

Source§

impl<B: Clone + BlobStore> Clone for FileStorage<B>

Source§

fn clone(&self) -> FileStorage<B>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<B> Freeze for FileStorage<B>

§

impl<B> !RefUnwindSafe for FileStorage<B>

§

impl<B> Send for FileStorage<B>

§

impl<B> Sync for FileStorage<B>

§

impl<B> Unpin for FileStorage<B>

§

impl<B> !UnwindSafe for FileStorage<B>

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<T> Classify for T

§

type Classified = T

§

fn classify(self) -> T

§

impl<T> Classify for T

§

type Classified = T

§

fn classify(self) -> T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
§

impl<T> Declassify for T

§

type Declassified = T

§

fn declassify(self) -> T

§

impl<T> Declassify for T

§

type Declassified = T

§

fn declassify(self) -> T

Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DartSafe for T

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> TaskRetFutTrait for T
where T: Send,