Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • optparse.rb

Parent

OptionParser::ParseError

Base class of exceptions from OptionParser.

Constants

Reason

Reason which caused the error.

Attributes

args[R]
reason[W]

Public Class Methods

new(*args) click to toggle source
 
               # File optparse.rb, line 1599
def initialize(*args)
  @args = args
  @reason = nil
end
            

Public Instance Methods

inspect() click to toggle source
 
               # File optparse.rb, line 1631
def inspect
  "#<#{self.class.to_s}: #{args.join(' ')}>"
end
            
message() click to toggle source

Default stringizing method to emit standard error message.

 
               # File optparse.rb, line 1638
def message
  reason + ': ' + args.join(' ')
end
            
Also aliased as: to_s
reason() click to toggle source

Returns error reason. Override this for I18N.

 
               # File optparse.rb, line 1627
def reason
  @reason || self.class::Reason
end
            
recover(argv) click to toggle source

Pushes back erred argument(s) to argv.

 
               # File optparse.rb, line 1610
def recover(argv)
  argv[0, 0] = @args
  argv
end
            
set_option(opt, eq) click to toggle source
 
               # File optparse.rb, line 1615
def set_option(opt, eq)
  if eq
    @args[0] = opt
  else
    @args.unshift(opt)
  end
  self
end
            
to_s() click to toggle source
Alias for: message

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus