struct Cling::Options

Overview

An input structure to access validated options at execution time.

Defined in:

cling/option.cr

Instance Method Summary

Instance Method Detail

def [](key : String) : Option #

Indexes an option by its long name and returns the Option object, not the option's value.


[View source]
def [](key : Char) : Option #

Indexes an option by its short name and returns the Option object, not the option's value.


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

Indexes an option by its long name and returns the Option object or nil if not found, not the option's value.


[View source]
def []?(key : Char) : Option | Nil #

Indexes an option by its short name and returns the Option object or nil if not found, not the option's value.


[View source]
def empty? : Bool #

Returns true if there are no parsed options.


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

Gets an option by its short or long name and returns its Value.


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

Gets an option by its short or long name and returns its Value, or nil if not found.


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

Returns true if an option by the given long name exists.


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

Returns true if an option by the given short name exists.


[View source]
def hash : Hash(String, Option) #
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 options.


[View source]