模块:Mongo::Deprecations Private

扩展方式:
弃用可记录
包含在:
弃用
定义于:
lib/ Mongo/deprecations.rb

Overview

该模块是私有 API 的一部分。 您应尽可能避免使用此模块,因为它将来可能会被删除或更改。

用于报告驱动程序中已弃用的行为。当可以检测到正在使用已弃用的功能时,应通过此模块发出警告。

无论调用 Mongo::Deprecations.warn 多少次,该功能的警告最多只会发出一次。

例子:

发出弃用警告。

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

常量摘要折叠

互斥锁 =

此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。

用于同步访问权限警告功能的互斥锁。

线程::互斥锁.new

Loggable中包含的常量

Loggable::PREFIX

实例方法摘要折叠

Loggable中包含的方法

log_debug, log_error, log_fatal, log_info, log_warn, logger

实例方法详细信息

#clear!对象

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

清除先前警告功能的所有内存。



58
59
60
61
# File 'lib/ Mongo/deprecations.rb', line 58

def 清除!
  互斥锁.同步 { 警告特征 重置: true }
  nil
end

#warn (功能, message) ⇒ 对象

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

发出有关已弃用功能的警告。警告将写入记录器,并且每个功能不会被多次写入。

参数:

  • 功能 (String | Symbol)

    已弃用的功能。

  • message ( string )

    弃用消息。



30
31
32
33
34
35
36
37
# File 'lib/ Mongo/deprecations.rb', line 30

def WARN(功能, message)
  互斥锁.同步 do
    return if _warned?(功能)

    _warned!(功能)
    log_warn("[DEPRECATION:#{功能}] #{message}")
  end
end

# 警告! (功能) ⇒ 对象

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

标记已针对给定已弃用功能发出警告。

参数:

  • 功能 (String | Symbol)

    已弃用的功能。



52
53
54
55
# File 'lib/ Mongo/deprecations.rb', line 52

def 警告!(功能)
  互斥锁.同步 { _warned!(功能) }
  nil
end

# 警告? (功能, prefix: false) ⇒ true | false

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

检查是否已针对给定已弃用功能发出警告。

参数:

  • 功能 (String | Symbol)

    已弃用的功能。

  • prefix ( true | false ) (默认为: false

    是否检查前缀匹配。

返回:

  • ( true | false )

    如果已经发出警告。



45
46
47
# File 'lib/ Mongo/deprecations.rb', line 45

def 警告?(功能, prefix: false)
  互斥锁.同步 { _warned?(功能, prefix: prefix) }
end