Struct cannyls::device::Device

#[must_use]
pub struct Device { /* fields omitted */ }

Lump群を格納するためのデバイス.

モジュールドキュメントも参照のこと.

Future実装

DeviceはFutureを実装している.

実際の処理は、別スレッドで実行されるためFuture::pollを呼び出さなくても進行上は支障はないが、 このメソッドによりデバイス(スレッド)の終了(正常ないし異常)を検知することが可能となる.

なおDeviceインスタンスが破棄されると、裏で動いているデバイス用のOSスレッドも停止させられるので、 Future::pollを呼び出さない場合でも、インスタンス自体は保持しておく必要がある.

デバイスを安全に停止する方法

Device::spawn関数を呼び出すとDeviceインスタンスが結果として返されるが、 同時に引数で指定されたストレージを管理するためのOSスレッドも起動される。

Deviceインスタンスのドロップ時には、そのデストラクタ内でDevice::stopメソッドが呼び出され、 対応する管理スレッドに停止リクエストが発行される。 注意すべきは、デストラクタ内ではリクエストを発行するのみであり、停止完了を待機することはないという点である。 これは、デストラクタの呼び出し元スレッドが長時間ブロックすることを避けるための挙動である

通常はこの挙動で問題が発生することはないが、もし対象Deviceでジャーナルメモリバッファが有効になっており、 かつ、Deviceのドロップ直後にプログラムが終了する場合には、ジャーナルメモリバッファの内容が ディスクに反映される前に、管理スレッドが強制終了されてしまう可能性がある（i.e., 直近の操作内容が失われる）。

これを防ぐためには、以下のように明示的にDevice::stopを呼び出し上で、Deviceの終了を待機すれば良い:

use cannyls::deadline::Deadline;
use cannyls::device::Device;
use cannyls::nvm::MemoryNvm;
use cannyls::storage::Storage;
use futures::Future;

let nvm = MemoryNvm::new(vec![0; 1024 * 1024]);
let storage = Storage::create(nvm)?;
let mut device = Device::spawn(|| Ok(storage));

// ...デバイスに対する何らかの操作...

device.stop(Deadline::Immediate);    // 管理スレッドの停止を指示
while !device.poll()?.is_ready() {}  // 停止完了を待機

Methods

impl Device

pub fn spawn<F, N>(init_storage: F) -> Device where     F: FnOnce() -> Result<Storage<N>> + Send + 'static,     N: NonVolatileMemory + Send + 'static,

デフォルト設定でデバイスを起動する.

設定を変更したい場合にはDeviceBuilderを使用すること.

pub fn handle(&self) -> DeviceHandle

デバイスを操作するためのハンドルを返す.

pub fn stop(&self, deadline: Deadline)

デバイスに停止リクエストを発行する.

このメソッドが返った時点でデバイスが停止している保証はないので、 確実に終了を検知したい場合にはFuture::pollメソッド経由で知る必要がある.

なおDeviceインスタンスのドロップ時点で、そのデバイスがまだ稼働中の場合には stop(Deadline::Immediate)が自動で呼び出される. ただし、その後にデバイスの終了を待機したりはしないので注意は必要. 例えば「Deviceインスタンスをドロップして、直後に同じ設定でデバイスを起動」といったことを 行った場合には、停止中の旧インスタンスと起動した新インスタンスでリソース(e.g., ファイル)が 衝突し、エラーが発生するかもしれない. 確実な終了検知が必要なら、アプリケーションが明示的にDevice::stopを呼び出す必要がある.

pub fn wait_for_running(     self ) -> impl Future<Item = Self, Error = Error>

デバイスの起動を待機するためのFutureを返す.

Trait Implementations

impl Drop for Device

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for Device

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

Formats the value using the given formatter.

impl Future for Device

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = Error

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F> where     F: FnOnce(Self::Item) -> U,

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where     F: FnOnce(Self::Error) -> E,

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where     E: From<Self::Error>,

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where     B: IntoFuture,     F: FnOnce(Result<Self::Item, Self::Error>) -> B,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where     B: IntoFuture<Error = Self::Error>,     F: FnOnce(Self::Item) -> B,

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where     B: IntoFuture<Item = Self::Item>,     F: FnOnce(Self::Error) -> B,

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where     B: IntoFuture<Item = Self::Item, Error = Self::Error>,

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where     B: IntoFuture,

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where     B: IntoFuture<Error = Self::Error>,

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(     self,     b: B,     c: C ) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where     B: IntoFuture<Error = Self::Error>,     C: IntoFuture<Error = Self::Error>,

Same as join, but with more futures.

fn join4<B, C, D>(     self,     b: B,     c: C,     d: D ) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where     B: IntoFuture<Error = Self::Error>,     C: IntoFuture<Error = Self::Error>,     D: IntoFuture<Error = Self::Error>,

Same as join, but with more futures.

fn join5<B, C, D, E>(     self,     b: B,     c: C,     d: D,     e: E ) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where     B: IntoFuture<Error = Self::Error>,     C: IntoFuture<Error = Self::Error>,     D: IntoFuture<Error = Self::Error>,     E: IntoFuture<Error = Self::Error>,

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where     Self::Item: IntoFuture,     <Self::Item as IntoFuture>::Error: From<Self::Error>,

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where     Self::Item: Stream,     <Self::Item as Stream>::Error == Self::Error,

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where     F: FnOnce(&Self::Item),

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self> where     Self: UnwindSafe,

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.