クラス: Mongo::Crypt::Status Private

継承:
オブジェクト
  • オブジェクト
すべて表示
定義:
lib/mongo/crypt/status.rb

Overview

このクラスは、プライベート API の一部です。 このクラスは将来削除または変更される可能性があるため、可能な限り使用しないでください。

mongocrypt_status_t を囲み、mongocrypt_t ハンドルのステータスを表すラッパー。

クラスメソッドの概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

コンストラクターの詳細

#初期化（ポインター: nil） =ステータス

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注：

ポインターでステータス オブジェクトを初期化する場合、次のようになります

新しいステータス オブジェクトを作成する

Node .from_pointer を使用することを推奨 メソッド

パラメーター:

  • ポインター （ FFI::Pointer | nil ） （デフォルトはnil ） —

    既存の mongocrypt_status_t オブジェクトへのポインター。 デフォルトは nil です。



33
34
35
36
37
38
39
40
41
42
43
 
# ファイル 'lib/mongo/crypt/status.rb', 行 33

デフォルト 初期化(ポインター: nil)
  #ポインターが渡された場合、このクラスは次を担当しない
  # そのポインターを破棄し、データをアン割り当てます。
  #
  #FFI::AutoPointer はカスタム リリース戦略を使用して自動的に解放
  このオブジェクトがスコープを超えるとポインターは 表示されます
  @status = ポインター || FFI::AutoPointer.新着情報(
    バインディング.mongocrypt_status_new,
    バインディング.メソッド(:mongocrypt_status_detry)
  )
end

クラスメソッドの詳細

。 from_pointer （ポインター）= Mongo::Crypt::Status

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ステータス オブジェクトを既存のポインターから mongocrypt_status_t オブジェクトに初期化します。

パラメーター:

  • ポインター （ FFI ::Pointer ） —

    既存の mongocrypt_status_t オブジェクトへのポインター

次の値を返します。



52
53
54
 
# ファイル 'lib/mongo/crypt/status.rb', 行 52

デフォルト 自己.from_pointer(ポインター)
  新着情報(ポインター: ポインター)
end

インスタンス メソッドの詳細

#code ⇒ Integer

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ステータスに関連付けられた整数コードを返します

次の値を返します。

  • (整数) —

    ステータス コード、デフォルトは0



88
89
90
 
# ファイル 'lib/mongo/crypt/status.rb', 行 88

デフォルト コード
  バインディング.mongocrypt_status_code(@status)
end

#label ⇒ Symbol

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ステータスのラベルを返します

次の値を返します。

  • （シンボル） —

    ステータス ラベル（:ok、:error_ kms、または :error_client のいずれか）は、デフォルトで :ok



81
82
83
 
# ファイル 'lib/mongo/crypt/status.rb', 行 81

デフォルト ラベル
  バインディング.mongocrypt_status_type(@status)
end

#メッセージ= string

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ステータス メッセージを返す

次の値を返します。

  • ( string ) —

    ステータス メッセージ。デフォルトは空の string



95
96
97
98
 
# ファイル 'lib/mongo/crypt/status.rb', 行 95

デフォルト メッセージ
  メッセージ = バインディング.mongocrypt_status_message(@status, nil)
  メッセージ || ''
end

#ok? ⇒ Boolean

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ステータスに :ok のラベルが付いているかどうかを確認します。

次の値を返します。

  • （ブール値） —

    ステータスが :ok かどうか



103
104
105
 
# ファイル 'lib/mongo/crypt/status.rb', 行 103

デフォルト ok?
  バインディング.mongocrypt_status_ok(@status)
end

# accumulate_crypt_error ( KMS : false) =オブジェクト

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注：

KMSパラメータが false の場合でも、エラーはKMSからのものである可能性があります。 KMSパラメーターは、すべてのエラーをKMSエラーとして扱うように強制します。

このステータスに保存されている情報に対応する Mongo::Error:CryptError を発生させます。

private.ok の場合は何も行いませんか。は true

パラメーター:

  • KMS （ true | false ） （デフォルトはfalse ） —

    操作が KMS に対して実行されたかどうか。



125
126
127
128
129
130
131
132
133
134
135
 
# ファイル 'lib/mongo/crypt/status.rb', 行 125

デフォルト resume_crypt_error(KMS : false)
  return 場合 ok?

  エラー = 場合 KMS || ラベル == :error_ kms
            エラー::KmsError.新着情報(メッセージ, コード: コード)
          else
            エラー::CryptError.新着情報(メッセージ, コード: コード)
          end

  発生 エラー
end

参照: FFI::Pointer

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

基礎となる mongocrypt_status_t オブジェクトへの参照を返します

次の値を返します。

  • （ FFI ::Pointer ） —

    基礎の mongocrypt_status_tオブジェクトへのポインター



111
112
113
 
# ファイル 'lib/mongo/crypt/status.rb', 行 111

デフォルト 参照
  @status
end

更新（ラベル、コード、メッセージ）= Mongo::Crypt::Status

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ステータスでラベル、コード、メッセージを設定する

パラメーター:

  • ラベル （シンボル） —

    :ok、:error_client、:error_ kms のいずれか 1 つ

  • コード （整数）
  • メッセージ （ string ）

次の値を返します。



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# ファイル 'lib/mongo/crypt/status.rb', 行 63

デフォルト update(ラベル, コード, メッセージ)
  ただし、 %i[Ok errors_client errors_ kms].include?(ラベル)
    発生 ArgumentError.新着情報(
      " #{ラベル}は Mongo::Crypt::Status ラベルの無効値です。 +
      ラベルには、次のいずれかの値が必要です::ok、:error_client、:error_ kms 。
    )
  end

  message_Length = メッセージ ? メッセージ.bytesize + 1 : 0
  バインディング.mongocrypt_status_set(@status, ラベル, コード, メッセージ, message_Length)

  自己
end