Descendents of class StructuredWarnings::Base are used to raise structured warnings. They enable programmers to explicitly supress certain kinds of warnings and provide additional information in contrast to the plain warn method. They implement an Exception-like interface and carry information about the warning — its type (the warning‘s class name), an optional descriptive string, and optional traceback information. Programs may subclass StructuredWarnings::Base to add additional information.

Large portions of this class‘s documentation are taken from the Exception RDoc.