Module: Mongo::Error::Labelable

Included in:
Auth::Unauthorized, Mongo::Error
Defined in:
build/ruby-driver-v2.19/lib/mongo/error/labelable.rb

Overview

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.

A module encapsulating functionality to manage labels added to errors.

Since:

  • 2.0.0

Instance Method Summary collapse

Instance Method Details

#add_label(label) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Adds the specified label to the error instance, if the label is not already in the set of labels.

Parameters:

  • label (String) —

    The label to add.

Since:

  • 2.0.0



66
67
68
69
 
# File 'build/ruby-driver-v2.19/lib/mongo/error/labelable.rb', line 66

def add_label(label)
  @labels ||= []
  @labels << label unless label?(label)
end

#label?(label) ⇒ true, false

Does the error have the given label?

Examples:

error.label?(label)

Parameters:

  • label (String) —

    The label to check if the error has.

Returns:

  • (true, false) —

    Whether the error has the given label.

Since:

  • 2.6.0



40
41
42
 
# File 'build/ruby-driver-v2.19/lib/mongo/error/labelable.rb', line 40

def label?(label)
  @labels && @labels.include?(label)
end

#labels ⇒ Array

Gets the set of labels associated with the error.

Examples:

error.labels

Returns:

  • (Array) —

    The set of labels.

Since:

  • 2.7.0



52
53
54
55
56
57
58
 
# File 'build/ruby-driver-v2.19/lib/mongo/error/labelable.rb', line 52

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