模块:Mongo::Error::Labelable

包含在:
Auth::UnauthorizedMongo::Error
定义于:
build/Ruby-driver-v 2.19 /lib/mongo/error/labelable.rb

Overview

注意:

尽管该模块的方法是公共 API 的一部分,但这些方法是在此模块上定义的,而不是在包含该模块的类上定义的,因此,公共 API 不属于该模块的一部分。

封装用于管理添加到错误的标签的功能的模块。

由于:

  • 2.0.0

实例方法摘要折叠

实例方法详细信息

# add_label (label) ⇒对象

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

如果指定标签尚不在标签设立,则将指定标签添加到错误实例中。

参数:

  • 标签 ( string )

    要添加的标签。

由于:

  • 2.0.0



66
67
68
69
# File ' 构建/ruby-driver-v2.19/lib/ mongo /error/labelable.rb', 第66行

def add_label(标签)
  @labels ||= []
  @labels << 标签 除非 标签?(标签)
end

#标签? (标签)→ true , false

错误是否具有给定标签?

例子:

error.label?(label)

参数:

  • 标签 ( string )

    用于检查错误是否存在的标签。

返回:

  • ( true , false )

    错误是否具有给定标签。

由于:

  • 2.6.0



40
41
42
# File ' 构建/ruby-driver-v2.19/lib/ mongo /error/labelable.rb', 第40行

def 标签?(标签)
  @labels && @labels.包括?(标签)
end

# labels数组

获取与错误关联的标签设立。

例子:

error.labels

返回:

  • ( Array )

    标签集。

由于:

  • 2.7.0



52
53
54
55
56
57
58
# File ' 构建/ruby-driver-v2.19/lib/ mongo /error/labelable.rb', 第52行

def labels
  if @labels
    @labels.dup
  else
    []
  end
end