FileProvider

Struct FileProvider 

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

The FileProvider is the primary method of retrieving raw data from the cache.

In order to function correctly, an index, archive and file ID must be supplied.

The index is type usize, and the archive and file ID can either be a u32 reference (&u32) or a String reference (&String).

use idx::util::FileProvider;
use idx::util::CacheBuilder;

let cache = CacheBuilder::new()
              .with_path("test_cache")
              .build();
                
let mut data_provider = FileProvider::from(&cache);
  
data_provider.index(19).archive(&6);
let data = data_provider.request(&17); //Returns the raw data for file 17 in archive 6 of index 19.

assert_ne!(0, data.len());

Implementations§

Source§

impl FileProvider

Source

pub fn from(cache: &Arc<Mutex<Cache>>) -> Self

Source

pub fn index(&mut self, index: u32) -> &mut Self

Source

pub fn archive(&mut self, archive: &dyn ContainerIdProvider) -> &mut Self

Source

pub fn with_keys(&mut self, keys: Vec<i64>)

Source

pub fn request(&mut self, file: &dyn ContainerIdProvider) -> DataBuffer

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