Struct cannyls::nvm::FileNvm

pub struct FileNvm { /* fields omitted */ }

ファイルベースのNonVolatileMemoryの実装.

現状の実装ではブロックサイズはBlockSize::min()に固定.

UNIX環境であれば、ファイルはO_DIRECTフラグ付きでオープンされる.

参考

O_DIRECTとO_SYNC/O_DSYNCに関して:

• http://stackoverflow.com/questions/5055859/
• https://lwn.net/Articles/457667/

Methods

impl FileNvm

pub fn create_if_absent<P: AsRef<Path>>(
    filepath: P,
    capacity: u64
) -> Result<(Self, bool)>

デフォルト設定で新しいFileNvmインスタンスを生成する.

デフォルト設定では、O_DIRECT (MacではF_NOCACHE）でのバッファリングなしI/Oを行い ファイルアクセスに対する排他制御を行う。

filepathが既に存在する場合にはそれを開き、存在しない場合には新規にファイルを作成する.

返り値のタプルの二番目の値は、ファイルが新規作成されたかどうか (trueなら新規作成).

pub fn create<P: AsRef<Path>>(filepath: P, capacity: u64) -> Result<Self>

デフォルト設定でファイルを新規に作成してFileNvmインスタンスを生成する.

デフォルト設定では、O_DIRECT (MacではF_NOCACHE）でのバッファリングなしI/Oを行い ファイルアクセスに対する排他制御を行う。

pub fn open<P: AsRef<Path>>(filepath: P) -> Result<Self>

デフォルト設定で既存のファイルを開きFileNvmインスタンスを生成する。

デフォルト設定では、O_DIRECT (MacではF_NOCACHE）でのバッファリングなしI/Oを行い ファイルアクセスに対する排他制御を行う。

ここでいう既存のファイルとは、以前に Storage::create 等で 作成済みのlusfファイルを指す。

lusfファイルにはcapacity情報が埋め込まれているので createとは異なりcapacity引数を要求しない。

Trait Implementations

impl Debug for FileNvm

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

Formats the value using the given formatter.

impl NonVolatileMemory for FileNvm

fn sync(&mut self) -> Result<()>

メモリの内容を、物理デバイスに同期する.

fn position(&self) -> u64

読み書き用カーソルの現在位置を返す.

fn capacity(&self) -> u64

メモリの容量(バイト単位)を返す.

fn block_size(&self) -> BlockSize

このインスタンスのブロックサイズを返す.

fn split(self, position: u64) -> Result<(Self, Self)>

メモリを指定位置で分割する.

fn convert_to_offset(&self, pos: SeekFrom) -> Result<u64>

SeekFrom形式で指定された位置を、開始地点からのオフセットに変換する.

fn aligned_write_all<F>(&mut self, f: F) -> Result<()> where
    F: FnOnce(&mut Vec<u8>) -> Result<()>, 

このインスタンスが指定するブロック境界へのアライメントを保証した書き込みを行う.

fn aligned_read_bytes(&mut self, size: usize) -> Result<AlignedBytes>

このインスタンスが指定するブロック境界へのアライメントを保証した上で、指定サイズ分のバイト列を読み込む.

impl Read for FileNvm

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Seek for FileNvm

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬 This is a nightly-only experimental API. (seek_convenience)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

🔬 This is a nightly-only experimental API. (seek_convenience)

Returns the current seek position from the start of the stream.

impl Write for FileNvm

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.