Struct RandomAccessFile

pub struct RandomAccessFile { /* private fields */ }

A RandomAccessFile in memory. This is not used to serialize data

Implementations

impl RandomAccessFile

pub fn meta(&self) -> &RandomAccessFileMeta

pub fn id(&self) -> &Option<Digest>

pub fn key(&self) -> &Option<SymKey>

pub fn new_from_slice( content: &[u8], block_size: usize, content_type: String, metadata: Vec<u8>, store: Arc<Store>, ) -> Result<RandomAccessFile, FileError>

Creates a new file based on a content that is fully known at the time of creation.

If you want to stream progressively the content into the new file, you should use new_empty(), write() and save() instead

pub fn new_empty( block_size: usize, content_type: String, metadata: Vec<u8>, store: Arc<Store>, ) -> RandomAccessFile

pub fn write(&mut self, data: &[u8]) -> Result<(), FileError>

Appends some data at the end of the file currently created with new_empty() and not saved yet. you can call it many times. Don’t forget to eventually call save()

pub fn save(&mut self) -> Result<Digest, FileError>

pub fn reference(&self) -> Option<BlockRef>

pub fn open( id: Digest, key: SymKey, store: Arc<Store>, ) -> Result<RandomAccessFile, FileError>

Opens a file for read purpose.

pub fn blocks(&self) -> impl Iterator<Item = Block>

pub fn size(&self) -> usize

Size once encoded, before deduplication. Only available before save()

pub fn dedup_size(&self) -> usize

Real size on disk

pub fn depth(&self) -> Result<u8, NgError>

Trait Implementations

impl Display for RandomAccessFile

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

Formats the value using the given formatter.

impl ReadFile for RandomAccessFile

fn read(&self, pos: usize, size: usize) -> Result<Vec<u8>, FileError>

reads at most one block from the file. the returned vector should be tested for size. it might be smaller than what you asked for. position can be anywhere in the file.

fn get_all_blocks_ids(&self) -> Result<Vec<Digest>, FileError>