Struct cannyls::nvm::FileNvmBuilder

pub struct FileNvmBuilder { /* fields omitted */ }

FileNvmのビルダ

FileNvmには二つのオプションdirect_ioとexclusive_lockが存在する。
デフォルトではdirect_io=trueかつexclusive_lock=trueの振る舞いをする。
それぞれのオプション内容については個別のメソッドを参照せよ。

Implementations

impl FileNvmBuilder

pub fn new() -> Self

デフォルト設定でFileNvmBuilderインスタンスを作成する

pub fn direct_io(&mut self, enabled: bool) -> &mut Self

Direct I/O（バッファリングなしIO）を行うかどうかを設定する。
デフォルトではDirect I/Oを行う。

• enabled=trueでDirect I/Oを行う。
• enabled=falseでDirect I/Oを行わない。

現状ではLinuxとMacのみで有効なオプションで、それぞれ次を意味する:

• Linux: O_DIRECTオプションでファイルを開く。
• Mac: ファイルを開いた後にF_NOCACHEオプションを付与する。

pub fn exclusive_lock(&mut self, enabled: bool) -> &mut Self

ファイルに対する排他ロックを行うかどうかを設定する。
デフォルトでは排他ロックを行う。

• enabled=trueで排他ロックを行う。
• enabled=falseで排他ロックを行わない。

現状ではUnix系で有効なオプションで、次を意味する:

• LOCK_EXとLOCK_NBオプションを用いてflockシステムコールを呼び出す。

pub fn create_if_absent<P: AsRef<Path>>(
    &mut self,
    filepath: P,
    capacity: u64
) -> Result<(FileNvm, bool)>

新しいFileNvmインスタンスを生成する.

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

返り値のタプルの二番目のbool値は、次を意味する

• true: ファイルが新規作成された、または既にファイルが存在したがそれが0バイトの空ファイルである。
• false: 非空なファイルが存在していた。

pub fn create<P: AsRef<Path>>(
    &mut self,
    filepath: P,
    capacity: u64
) -> Result<FileNvm>

ファイルを新規に作成してFileNvmインスタンスを生成する.

filepathにファイルが存在する場合にはエラーを返す。
filepathに（非零バイト）ファイルが存在する場合にそれを開きたいならば、 このメソッドの代わりにcreate_if_absentを用いる。

pub fn open<P: AsRef<Path>>(&mut self, filepath: P) -> Result<FileNvm>

既存のファイルを開いてFileNvmインスタンスを生成する。

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

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

Trait Implementations

impl Default for FileNvmBuilder

fn default() -> Self

Returns the "default value" for a type.