class

Optarg::Model

Inherits Reference < Object

The base of model classes.

Class methods

parse(argv : Array(String), *args)

Creates a new model instance and parses the argv arguments.

Returns the created instance.

Source

Instance methods

[](klass : String.class)

Returns a value hash for String-type options and arguments.

Source

[](klass : Bool.class)

Returns a value hash for Bool-type options and arguments.

Source

[](klass : Array(String).class)

Returns a value hash for Array(String)-type options and arguments.

Source

[](index : Int32)

Returns an argument value at the index.

Source

[]?(index : Int32)

Returns an argument value at the index.

Returns nil if the index is out of range.

Source

each

Iterates argument values.

Source

nameless_args

Returns an array that contains nameless argument values.

Source

unparsed_args

Returns an array that contains unparsed argument values.

Source

Macros

arg(names, metadata = nil, stop = nil, default = nil, required = nil, any_of = nil, complete = nil, _mixin = nil, &block)

Defines a String argument model item.

Source

arg_array(names, metadata = nil, default = nil, min = nil, any_item_of = nil, complete = nil, _mixin = nil, &block)

Defines an Array(String) argument model item.

Source

array(names, metadata = nil, default = nil, min = nil, any_item_of = nil, complete = nil, _mixin = nil, &block)

Defines an Array(String) option model item.

Source

bool(names, metadata = nil, stop = nil, default = nil, not = nil, _mixin = nil, &block)

Defines a Bool option model item.

Source

on(names, metadata = nil, stop = nil, &block)

Defines a handler model item.

Source

string(names, metadata = nil, stop = nil, default = nil, required = nil, any_of = nil, complete = nil, _mixin = nil, &block)

Defines a String option model item.

Source

terminator(names, metadata = nil)

Defines a terminator model item.

Source

unknown(metadata = nil)

Defines an unknown model item.

Source