Class: Toys::ArgParser::FlagAmbiguousError

Inherits:

UsageError

• Object
• UsageError
• Toys::ArgParser::FlagAmbiguousError

Defined in:

lib/toys/arg_parser.rb

Overview

A UsageError indicating a flag name prefix was given that matched multiple flags.

Instance Attribute Summary

Attributes inherited from UsageError

#message, #name, #suggestions, #value

Instance Method Summary

• #initialize(message = nil, value: nil, suggestions: nil) ⇒ FlagAmbiguousError constructor

  Create a FlagAmbiguousError.

Methods inherited from UsageError

#full_message

Constructor Details

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

Create a FlagAmbiguousError.

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.

# File 'lib/toys/arg_parser.rb', line 152

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