[−][src]Struct zbox::Repo
An encrypted repository contains the whole file system.
A Repo
represents a secure collection which consists of files,
directories and their associated data. Similar to std::fs
, Repo
provides methods to manipulate the enclosed file system.
Storages
ZboxFS supports a variety of underlying storages, which are listed below.
Storage | URI identifier | Cargo Feature |
---|---|---|
Memory | "mem://" | N/A |
OS file system | "file://" | storage-file |
SQLite | "sqlite://" | storage-sqlite |
Redis | "redis://" | storage-redis |
By default, only memory storage is enabled. To use other storages, you need to specify it as dependency features in your Cargo.toml.
For example, to use OS file as underlying storage, specify its feature in your project's Cargo.toml file.
[dependencies]
zbox = { version = "0.8.2", features = ["storage-file"] }
Create and open Repo
Repo
can be created on different underlying storages using RepoOpener
.
It uses an URI-like string to specify its storage type and location. The
URI string starts with an identifier which specifies the storage type, as
shown in above table. You can check more location URI details at:
RepoOpener.
Repo
can only be opened once at a time. After opened, it keeps locked
from other open attempts until it goes out scope.
Optionally, Repo
can be opened in read-only
mode if you only need
read access.
Examples
Create an OS file system based repository.
use zbox::{init_env, RepoOpener}; init_env(); let mut repo = RepoOpener::new() .create(true) .open("file:///path/to/repo", "pwd")?;
Create a memory based repository.
let mut repo = RepoOpener::new().create(true).open("mem://foo", "pwd")?;
Open a repository in read-only mode.
let mut repo = RepoOpener::new() .read_only(true) .open("file:///path/to/repo", "pwd")?;
Methods
impl Repo
[src]
pub fn exists(uri: &str) -> Result<bool>
[src]
Returns whether the URI points at an existing repository.
Existence check depends on the underlying storage implementation, for memory storage, it always returns false. For file storage, it will return if the specified path exists on the OS file system.
pub fn info(&self) -> Result<RepoInfo>
[src]
Get repository metadata infomation.
pub fn reset_password(
&mut self,
old_pwd: &str,
new_pwd: &str,
ops_limit: OpsLimit,
mem_limit: MemLimit
) -> Result<()>
[src]
&mut self,
old_pwd: &str,
new_pwd: &str,
ops_limit: OpsLimit,
mem_limit: MemLimit
) -> Result<()>
Reset password for the respository.
Note: if this method failed due to IO error, super block might be damaged. If so, use repair_super_block to restore super block before re-open the repo.
pub fn repair_super_block(uri: &str, pwd: &str) -> Result<()>
[src]
Repair possibly damaged super block.
This method will try to repair super block using backup. One scenario is when reset_password failed due to IO error, super block might be damaged. Using this method can restore the damaged super block from backup. If super block is all good, this method is no-op.
This method is not useful for memory-based storage and must be called when repo is closed.
pub fn path_exists<P: AsRef<Path>>(&self, path: P) -> Result<bool>
[src]
Returns whether the path points at an existing entity in repository.
path
must be an absolute path.
pub fn is_file<P: AsRef<Path>>(&self, path: P) -> Result<bool>
[src]
Returns whether the path exists in repository and is pointing at a regular file.
path
must be an absolute path.
pub fn is_dir<P: AsRef<Path>>(&self, path: P) -> Result<bool>
[src]
Returns whether the path exists in repository and is pointing at a directory.
path
must be an absolute path.
pub fn create_file<P: AsRef<Path>>(&mut self, path: P) -> Result<File>
[src]
Create a file in read-write mode.
This method will create a file if it does not exist, and will truncate it if it does.
See the OpenOptions::open
method for more details.
path
must be an absolute path.
pub fn open_file<P: AsRef<Path>>(&mut self, path: P) -> Result<File>
[src]
Attempts to open a file in read-only mode.
path
must be an absolute path.
See the OpenOptions::open
method for more details.
Errors
This method will return an error if path does not already exist.
Other errors may also be returned according to OpenOptions::open
.
Examples
let mut f = repo.open_file("foo.txt")?;
pub fn create_dir<P: AsRef<Path>>(&mut self, path: P) -> Result<()>
[src]
Creates a new, empty directory at the specified path.
path
must be an absolute path.
pub fn create_dir_all<P: AsRef<Path>>(&mut self, path: P) -> Result<()>
[src]
Recursively create a directory and all of its parent components if they are missing.
path
must be an absolute path.
pub fn read_dir<P: AsRef<Path>>(&self, path: P) -> Result<Vec<DirEntry>>
[src]
Returns a vector of all the entries within a directory.
path
must be an absolute path.
pub fn metadata<P: AsRef<Path>>(&self, path: P) -> Result<Metadata>
[src]
Get the metadata about a file or directory at specified path.
path
must be an absolute path.
pub fn history<P: AsRef<Path>>(&self, path: P) -> Result<Vec<Version>>
[src]
Return a vector of history versions of a regular file at specified path.
path
must be an absolute path to a regular file.
pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(
&mut self,
from: P,
to: Q
) -> Result<()>
[src]
&mut self,
from: P,
to: Q
) -> Result<()>
Copies the content of one file to another.
This mthod will overwrite the content of to
.
If from
and to
both point to the same file, this method is no-op.
from
and to
must be absolute paths to regular files.
pub fn remove_file<P: AsRef<Path>>(&mut self, path: P) -> Result<()>
[src]
Removes a regular file from the repository.
path
must be an absolute path.
pub fn remove_dir<P: AsRef<Path>>(&mut self, path: P) -> Result<()>
[src]
Remove an existing empty directory.
path
must be an absolute path.
pub fn remove_dir_all<P: AsRef<Path>>(&mut self, path: P) -> Result<()>
[src]
Removes a directory at this path, after removing all its children. Use carefully!
path
must be an absolute path.
pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(
&mut self,
from: P,
to: Q
) -> Result<()>
[src]
&mut self,
from: P,
to: Q
) -> Result<()>
Rename a file or directory to a new name, replacing the original file
if to
already exists.
from
and to
must be absolute paths.
Trait Implementations
Auto Trait Implementations
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,