Skip to main content

FileStore

Struct FileStore 

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

An abstract interface over one or more storage transports.

Supports separate writable and read-only transport pools. Write operations (upload, put, delete) only target writable transports. Read operations (download, get, exists, stream) search both pools, with read-only transports used as a fallback for data that hasn’t been migrated to the primary storage.

Implementations§

Source§

impl FileStore

Source

pub async fn open(urls: &[String]) -> Result<Arc<FileStore>>

Open all urls with default parameters

Source

pub async fn with_limit_retries(url: &str) -> Result<Arc<FileStore>>

Open a single url with retrying disabled

Source

pub async fn put(&self, name: &str, body: &Bytes) -> Result<()>

Upload a buffer to all writable transports. Read-only transports are skipped.

Source

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

Check if a given blob is defined in any transport (writable or read-only). Errors will be supressed as long as any transport contains the file.

Source

pub async fn get(&self, name: &str) -> Result<Option<Vec<u8>>>

Pull blob to in memory buffer from any transport (writable or read-only). Returns errors only if all transports fail, otherwise errors will be logged as warnings.

Source

pub async fn download(&self, name: &str, path: &Path) -> Result<()>

Download a blob and write it to a local file from any transport (writable or read-only). If the file does not exist it will be created. If it does exist it will be replaced.

Source

pub async fn upload(&self, path: &Path, name: &str) -> Result<()>

Upload a local file as a named blob to writable transports only. Read-only transports are skipped.

Source

pub async fn upload_batch( &self, local_remote_tuples: &[(&Path, &str)], ) -> Vec<(PathBuf, String, String)>

Upload a collection of local files to writable transports only.

Source

pub async fn stream( &self, name: &str, ) -> Result<(u64, Receiver<Result<Bytes, Error>>)>

Stream the content of a blob from any transport (writable or read-only). Returns the total expected length of the stream and a message receiver of data buffers.

Source

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

Remove a blob from writable storage only. Read-only transports are skipped.

Trait Implementations§

Source§

impl Debug for FileStore

Source§

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

Formats the value using the given formatter. 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

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

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,