Skip to main content

Storage

Struct Storage 

Source
pub struct Storage { /* private fields */ }
Expand description

Storage facade for file operations.

Implementations§

Source§

impl Storage

Source

pub fn new() -> Self

Create a new storage instance with a default local disk.

Source

pub fn with_config(default_disk: &str, configs: Vec<(&str, DiskConfig)>) -> Self

Create storage with custom configuration.

Source

pub fn with_storage_config(config: StorageConfig) -> Self

Create storage from a StorageConfig (typically loaded from environment).

§Example
use ferro_storage::{Storage, StorageConfig};

// Load configuration from environment variables
let config = StorageConfig::from_env();
let storage = Storage::with_storage_config(config);

// Or use the builder pattern
let config = StorageConfig::new("local")
    .disk("local", DiskConfig::local("./storage"))
    .disk("public", DiskConfig::local("./public").with_url("/storage"));
let storage = Storage::with_storage_config(config);
Source

pub fn disk(&self, name: &str) -> Result<Disk, Error>

Get a specific disk.

Source

pub fn default_disk(&self) -> Result<Disk, Error>

Get the default disk.

Source

pub fn register_disk( &self, name: impl Into<String>, driver: Arc<dyn StorageDriver>, )

Register a disk.

Source

pub async fn exists(&self, path: &str) -> Result<bool, Error>

Check if a file exists.

Source

pub async fn get(&self, path: &str) -> Result<Bytes, Error>

Get file contents.

Source

pub async fn get_string(&self, path: &str) -> Result<String, Error>

Get file as string.

Source

pub async fn put( &self, path: &str, contents: impl Into<Bytes>, ) -> Result<(), Error>

Put file contents.

Source

pub async fn put_with_options( &self, path: &str, contents: impl Into<Bytes>, options: PutOptions, ) -> Result<(), Error>

Put with options.

Source

pub async fn delete(&self, path: &str) -> Result<(), Error>

Delete a file.

Source

pub async fn copy(&self, from: &str, to: &str) -> Result<(), Error>

Copy a file.

Source

pub async fn rename(&self, from: &str, to: &str) -> Result<(), Error>

Move a file.

Source

pub async fn url(&self, path: &str) -> Result<String, Error>

Get file URL.

Trait Implementations§

Source§

impl Clone for Storage

Source§

fn clone(&self) -> Storage

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

impl Default for Storage

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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