struct Cling::Arguments
- Cling::Arguments
- Struct
- Value
- Object
Overview
An input structure to access validated arguments at execution time.
Defined in:
cling/argument.crInstance Method Summary
-
#[](key : String) : Argument
Indexes an argument by its name and returns the
Argument
object, not the argument's value. -
#[]?(key : String) : Argument | Nil
Indexes an argument by its name and returns the
Argument
object ornil
if not found, not the argument's value. -
#empty? : Bool
Returns
true
if there are no parsed arguments. -
#get(key : String) : Value
Gets an argument by its name and returns its
Value
. -
#get?(key : String) : Value | Nil
Gets an argument by its name and returns its
Value
, ornil
if not found. -
#has?(key : String) : Bool
Returns
true
if an argument by the given name exists. -
#hash : Hash(String, Argument)
Generates an
UInt64
hash value for this object. -
#size : Int32
Returns the number of parsed arguments.
Instance Method Detail
Indexes an argument by its name and returns the Argument
object, not the argument's
value.
Indexes an argument by its name and returns the Argument
object or nil
if not found,
not the argument's value.
Gets an argument by its name and returns its Value
, or nil
if not found.
Generates an UInt64
hash value for this object.
This method must have the property that a == b
implies a.hash == b.hash
.
The hash value is used along with ==
by the Hash
class to determine if two objects
reference the same hash key.
Subclasses must not override this method. Instead, they must define hash(hasher)
,
though usually the macro def_hash
can be used to generate this method.