モジュール: Mongo::Deprecs Private

次による拡張機能。
非推奨、ログ記録可能
次のドキュメントに含まれます。
非推奨
定義:
lib/mongo/deprecation.rb

Overview

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

ドライバーの非推奨の動作を報告するために使用されます。非推奨の機能が使用されていることを検出できる場合は、このモジュールから警告が発行される必要があります。

Mongo::Deprecation.write が呼び出された回数に関係なく、その機能に対して警告が 1 回だけ発行されます。

例:

非推奨警告 を発行します。

Mongo::Deprecations.warn(:old_feature, "The old_feature is deprecated, use new_feature instead.")

定数の概要の削減

ミューテックス =

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

警告機能へのアクセスを同期するためのミューテックス。

スレッド::ミューテックス.新着情報

Loggableに含まれる定数

ログ可能::PRFIX

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

Loggableに含まれるメソッド

log_debug, log_error, log_fatal, log_info, log_warn, logger

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

# クリアします。 = オブジェクト

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

以前に警告された機能のすべてのメモリをクリアします。



58
59
60
61
 
# ファイル 'lib/mongo/deprecs.rb' 行 58

デフォルト クリアします。
  ミューテックス.同期 { 警告_機能 リセット: true }
  nil
end

# 警告（機能、メッセージ） ⇒ オブジェクト

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

非推奨の機能に関する警告を発行します。警告はロガーに書き込まれ、機能ごとに複数回書き込まれることはありません。

パラメーター:

  • 機能 （String | Symbol） —

    非推奨の機能。

  • メッセージ ( string ) —

    非推奨メッセージ。



30
31
32
33
34
35
36
37
 
# ファイル 'lib/mongo/deprecs.rb' 行 30

デフォルト WARN(機能, メッセージ)
  ミューテックス.同期 行う
    return 場合 _警告(機能)

    _警告。(機能)
    log_警告("[Deprecation:#{機能}] #{message}")
  end
end

# 警告。 （機能） ⇒ オブジェクト

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

特定の非推奨機能に対する警告が発行されたことをマークします。

パラメーター:

  • 機能 （String | Symbol） —

    非推奨の機能。



52
53
54
55
 
# ファイル 'lib/mongo/deprecs.rb' 行 52

デフォルト 警告が出されました。(機能)
  ミューテックス.同期 { _警告。(機能) }
  nil
end

# 警告（機能、プレフィックス: false） ⇒ true | false

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

特定の非推奨機能に対する警告がすでに発行されているかどうかを確認します。

パラメーター:

  • 機能 （String | Symbol） —

    非推奨の機能。

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

    プレフィックス一致を確認するかどうか。

次の値を返します。

  • （ true | false ） —

    警告がすでに発行されている場合。



45
46
47
 
# ファイル 'lib/mongo/deprecs.rb' 行 45

デフォルト 警告(機能, prefix: false)
  ミューテックス.同期 { _警告(機能, prefix: prefix) }
end