Struct Storage

Source

pub struct Storage {
    pub entries: HashMap<String, Entry>,
}

Fields§

§entries: HashMap<String, Entry>

Implementations§

Source §

impl Storage

Source

pub fn new(entries: HashMap<String, Entry>) -> Self

Create storage

Source

pub fn add<K: ToString, T: Into<Entry>>( &mut self, key: K, entry: T, ) -> Option<Entry>

Add new entry to storage

Works as HashMap::insert method, so will return Some(Entry) if it replaced older value

use kinda_virtual_fs::*;
 
let mut storage = Storage::default();
 
storage.add("example 1", "Hello, World!");
storage.add("example 2", Entry::new("Also accepts Entry struct"));

Source

pub fn get<T: ToString>(&self, key: T) -> Option<&Entry>

Get entry with the given key

Source

pub fn remove<T: ToString>(&mut self, key: T) -> Option<Entry>

Remove entry with the given key

Source

pub fn map<T: ToString>(&self, key: T) -> Result<String>

Try to map entry with specific key

use kinda_virtual_fs::*;
 
let mut storage = Storage::default();
 
storage.add("example", "Hello, World!");
 
let file_path = storage.map("example").expect("Failed to map entry");
let file_content = std::fs::read_to_string(file_path).expect("Failed to read mapped entry");
 
assert_eq!(&file_content, "Hello, World!");

Source

pub fn unmap<T: ToString>(&self, key: T) -> Result<()>

Unmap entry with specific key

Will return Ok(()) if there’s no entry with specified key

Entry will be automatically unmapped when its value is no more needed

§Manual unmapping

use kinda_virtual_fs::*;
 
let mut storage = Storage::default();
 
storage.add("example", "Hello, World!");
 
let path = storage.map("example").unwrap();
 
assert_eq!(std::path::Path::new(&path).exists(), true);
 
storage.unmap("example");
 
assert_eq!(std::path::Path::new(&path).exists(), false);

§Automatic unmapping

use kinda_virtual_fs::*;
 
let mut storage = Storage::default();
 
storage.add("example", "Hello, World!");
 
let path = storage.map("example").unwrap();
 
assert_eq!(std::path::Path::new(&path).exists(), true);
 
storage.remove("example");
 
assert_eq!(std::path::Path::new(&path).exists(), false);