Class: Toys::ArgParser::FlagUnrecognizedError

Inherits:
UsageError
  • Object
show all
Defined in:
lib/toys/arg_parser.rb

Overview

A UsageError indicating a flag name was not recognized.

Instance Attribute Summary

Attributes inherited from UsageError

#message, #name, #suggestions, #value

Instance Method Summary collapse

Methods inherited from UsageError

#full_message

Constructor Details

#initialize(message = nil, value: nil, suggestions: nil) ⇒ FlagUnrecognizedError

Create a FlagUnrecognizedError.

Parameters:

  • message (String, nil) (defaults to: nil) —

    A custom message. Normally omitted, in which case an appropriate default is supplied.

  • value (String) (defaults to: nil) —

    The requested flag name. Normally required.

  • suggestions (Array<String>) (defaults to: nil) —

    An array of suggestions to present to the user. Optional.



132
133
134
135
 
# File 'lib/toys/arg_parser.rb', line 132

def initialize(message = nil, value: nil, suggestions: nil)
  super(message || "Flag \"#{value}\" is not recognized.",
        value: value, suggestions: suggestions)
end