struct Cling::Arguments

Overview

An input structure to access validated arguments at execution time.

Defined in:

cling/argument.cr

Instance Method Summary

Instance Method Detail

def [](key : String) : Argument #

Indexes an argument by its name and returns the Argument object, not the argument's value.


[View source]
def []?(key : String) : Argument | Nil #

Indexes an argument by its name and returns the Argument object or nil if not found, not the argument's value.


[View source]
def empty? : Bool #

Returns true if there are no parsed arguments.


[View source]
def get(key : String) : Value #

Gets an argument by its name and returns its Value.


[View source]
def get?(key : String) : Value | Nil #

Gets an argument by its name and returns its Value, or nil if not found.


[View source]
def has?(key : String) : Bool #

Returns true if an argument by the given name exists.


[View source]
def hash : Hash(String, Argument) #
Description copied from class Object

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.


[View source]
def size : Int32 #

Returns the number of parsed arguments.


[View source]