Labelable — Documentation by YARD 0.9.37 (original) (raw)

Module: Mongo::Error::Labelable

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.

Instance Method Summarycollapse

• #add_label(label) ⇒ Object private
  Adds the specified label to the error instance, if the label is not already in the set of labels.
• #label?(label) ⇒ true, false
  Does the error have the given label?.
• #labels ⇒ Array
  Gets the set of labels associated with the error.

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.

| 66 67 68 69 | # File '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?

#labels ⇒ Array

Gets the set of labels associated with the error.