Struct cannyls_rpc::RequestBuilder

pub struct RequestBuilder<'a> { /* fields omitted */ }

RPCリクエストビルダ.

Methods

impl<'a> RequestBuilder<'a>

pub fn deadline(&mut self, deadline: Deadline) -> &mut Self

リクエスト処理のデッドライン(優先度)を指定する.

デフォルト値はDeadline::Infinity.

pub fn max_queue_len(&mut self, n: usize) -> &mut Self

リクエスト処理時のデバイスのキューの長さ制限を指定する.

このリクエストの処理時に、デバイスの要求キューの長さが、指定された値を超えている場合には、 リクエストは処理されずにErrorKind::DeviceBusyエラーが返される.

デフォルトでは制限なし.

pub fn rpc_options(&mut self, options: Options) -> &mut Self

RPCレベルのオプションを指定する.

デフォルト値はfibers_rpc::client::Options::default().

pub fn get_lump(     &self,     device_id: DeviceId,     lump_id: LumpId ) -> impl Future<Item = Option<Vec<u8>>, Error = Error>

Lumpデータの取得を行う.

指定されたlumpが存在しない場合にはOk(None)が返される.

Errors

例えば、以下のようなエラーが返されることがある:

• 指定されたデバイスが存在しない場合にはErrorKind::InvalidInput
• 指定されたデバイスが現在利用不可能な場合にはErrorKind::DeviceBusy

pub fn head_lump(     &self,     device_id: DeviceId,     lump_id: LumpId ) -> impl Future<Item = Option<LumpHeader>, Error = Error>

Lumpヘッダ(要約情報)の取得を行う.

指定されたlumpが存在しない場合にはOk(None)が返される.

Errors

例えば、以下のようなエラーが返されることがある:

• 指定されたデバイスが存在しない場合にはErrorKind::InvalidInput
• 指定されたデバイスが現在利用不可能な場合にはErrorKind::DeviceBusy

pub fn put_lump(     &self,     device_id: DeviceId,     lump_id: LumpId,     lump_data: LumpData ) -> impl Future<Item = bool, Error = Error>

Lumpの保存を行う.

返り値がOk(true)の場合には新規作成が、Ok(false)の場合には上書きが、行われたことを表している.

Errors

例えば、以下のようなエラーが返されることがある:

• 指定されたデバイスが存在しない場合にはErrorKind::InvalidInput
• 指定されたデバイスが現在利用不可能な場合にはErrorKind::DeviceBusy
• 指定されたデバイスの容量が満杯になっている場合にはErrorKind::Full

注意

現在は指定されたデータをジャーナル領域に埋め込むかどうかはRPCサーバ側が決定するため LumpData::new_embedded関数を用いてLumpDataを生成しても意味はない.

pub fn delete_lump(     &self,     device_id: DeviceId,     lump_id: LumpId ) -> impl Future<Item = bool, Error = Error>

Lumpの削除を行う.

返り値がOk(true)の場合には削除が行われたことを、 Ok(false)の場合には対象lumpが存在しなかったことを、表している.

Errors

例えば、以下のようなエラーが返されることがある:

• 指定されたデバイスが存在しない場合にはErrorKind::InvalidInput
• 指定されたデバイスが現在利用不可能な場合にはErrorKind::DeviceBusy

pub fn list_lumps(     &self,     device_id: DeviceId ) -> impl Future<Item = Vec<LumpId>, Error = Error>

デバイスに保存されているlumpのID一覧を取得する.

Errors

例えば、以下のようなエラーが返されることがある:

• 指定されたデバイスが存在しない場合にはErrorKind::InvalidInput
• 指定されたデバイスが現在利用不可能な場合にはErrorKind::DeviceBusy

Trait Implementations

impl<'a> Debug for RequestBuilder<'a>

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

Formats the value using the given formatter.