[−][src]Struct cannyls::device::Device
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
[src]
pub fn spawn<F, N>(init_storage: F) -> Device where
F: FnOnce() -> Result<Storage<N>> + Send + 'static,
N: NonVolatileMemory + Send + 'static,
[src]
F: FnOnce() -> Result<Storage<N>> + Send + 'static,
N: NonVolatileMemory + Send + 'static,
デフォルト設定でデバイスを起動する.
設定を変更したい場合にはDeviceBuilder
を使用すること.
pub fn handle(&self) -> DeviceHandle
[src]
デバイスを操作するためのハンドルを返す.
pub fn stop(&self, deadline: Deadline)
[src]
デバイスに停止リクエストを発行する.
このメソッドが返った時点でデバイスが停止している保証はないので、
確実に終了を検知したい場合にはFuture::poll
メソッド経由で知る必要がある.
なおDevice
インスタンスのドロップ時点で、そのデバイスがまだ稼働中の場合には
stop(Deadline::Immediate)
が自動で呼び出される.
ただし、その後にデバイスの終了を待機したりはしないので注意は必要.
例えば「Device
インスタンスをドロップして、直後に同じ設定でデバイスを起動」といったことを
行った場合には、停止中の旧インスタンスと起動した新インスタンスでリソース(e.g., ファイル)が
衝突し、エラーが発生するかもしれない.
確実な終了検知が必要なら、アプリケーションが明示的にDevice::stop
を呼び出す必要がある.
pub fn wait_for_running(self) -> impl Future<Item = Self, Error = Error>
[src]
デバイスの起動を待機するためのFuture
を返す.
Trait Implementations
impl Debug for Device
[src]
impl Drop for Device
[src]
impl Future for Device
[src]
type Item = ()
The type of value that this future will resolved with if it is successful. Read more
type Error = Error
The type of error that this future will resolve with if it fails in a normal fashion. Read more
fn poll(&mut self) -> Poll<Self::Item, Self::Error>
[src]
fn wait(self) -> Result<Self::Item, Self::Error>
[src]
fn map<F, U>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Item) -> U,
[src]
F: FnOnce(Self::Item) -> U,
fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]
F: FnOnce(Self::Error) -> E,
fn from_err<E>(self) -> FromErr<Self, E> where
E: From<Self::Error>,
[src]
E: From<Self::Error>,
fn then<F, B>(self, f: F) -> Then<Self, B, F> where
B: IntoFuture,
F: FnOnce(Result<Self::Item, Self::Error>) -> B,
[src]
B: IntoFuture,
F: FnOnce(Result<Self::Item, Self::Error>) -> B,
fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
B: IntoFuture<Error = Self::Error>,
F: FnOnce(Self::Item) -> B,
[src]
B: IntoFuture<Error = Self::Error>,
F: FnOnce(Self::Item) -> B,
fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
B: IntoFuture<Item = Self::Item>,
F: FnOnce(Self::Error) -> B,
[src]
B: IntoFuture<Item = Self::Item>,
F: FnOnce(Self::Error) -> B,
fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
B: IntoFuture<Item = Self::Item, Error = Self::Error>,
[src]
B: IntoFuture<Item = Self::Item, Error = Self::Error>,
fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
B: IntoFuture,
[src]
B: IntoFuture,
fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
B: IntoFuture<Error = Self::Error>,
[src]
B: IntoFuture<Error = Self::Error>,
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>,
[src]
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>,
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>,
[src]
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>,
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>,
[src]
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>,
fn into_stream(self) -> IntoStream<Self>
[src]
fn flatten(self) -> Flatten<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error: From<Self::Error>,
[src]
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error: From<Self::Error>,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Item: Stream,
<Self::Item as Stream>::Error == Self::Error,
[src]
Self::Item: Stream,
<Self::Item as Stream>::Error == Self::Error,
fn fuse(self) -> Fuse<Self>
[src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Item),
[src]
F: FnOnce(&Self::Item),
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
fn shared(self) -> Shared<Self>
[src]
Auto Trait Implementations
impl !RefUnwindSafe for Device
impl Send for Device
impl !Sync for Device
impl Unpin for Device
impl !UnwindSafe for Device
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Future = F
The future that this type can be converted into.
type Item = <F as Future>::Item
The item that the future may resolve with.
type Error = <F as Future>::Error
The error that the future may resolve with.
fn into_future(self) -> F
[src]
impl<T> TimerExt for T where
T: Future,
[src]
T: Future,
fn timeout_after(self, duration: Duration) -> TimeoutAfter<Self>
[src]
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>,