1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2019-2022 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
class Error
# A module encapsulating functionality to manage labels added to errors.
#
# @note Although methods of this module are part of the public API,
# the fact that these methods are defined on this module and not on
# the classes which include this module is not part of the public API.
#
# @api semipublic
module Labelable
# Does the error have the given label?
#
# @example
# error.label?(label)
#
# @param [ String ] label The label to check if the error has.
#
# @return [ true, false ] Whether the error has the given label.
#
# @since 2.6.0
def label?(label)
@labels && @labels.include?(label)
end
# Gets the set of labels associated with the error.
#
# @example
# error.labels
#
# @return [ Array ] The set of labels.
#
# @since 2.7.0
def labels
if @labels
@labels.dup
else
[]
end
end
# Adds the specified label to the error instance, if the label is not
# already in the set of labels.
#
# @param [ String ] label The label to add.
#
# @api private
def add_label(label)
@labels ||= []
@labels << label unless label?(label)
end
end
end
end
|
