class RemiLib::Args::StringArgument

Overview

An Argument that expects some sort of string value.

Included Modules

Defined in:

remilib/args/arg-types.cr

Instance Method Summary

Instance methods inherited from module RemiLib::Args::ValArgument

setValue!(val) : Nil setValue!, value value, value=(val) : Nil value=

Instance methods inherited from class RemiLib::Args::Argument

callback : ArgCallbackFunc | Nil callback, callback=(callback : ArgCallbackFunc | Nil) callback=, called? : Bool called?, group : String group, group=(group : String) group=, help : String help, help=(help : String) help=, longName : String longName, longName=(newName : String) : Nil longName=, shortName : Char | Nil shortName, shortName=(shortName : Char | Nil) shortName=

Constructor methods inherited from class RemiLib::Args::Argument

new(newLongName, shortName : Char | Nil = nil, group : String = "", help : String = "") new

Instance methods inherited from class Object

toRsconf(io : IO, *, indentSize : Int = 2, alwaysQuoteKeys : Bool = false, explicitRootObject : Bool = false, commaAfterValues : Bool = false, extraNewlineBetweenToplevelKeys : Bool = false) : Nil
toRsconf(*, indentSize : Int = 2, alwaysQuoteKeys : Bool = false, explicitRootObject : Bool = false, commaAfterValues : Bool = false, extraNewlineBetweenToplevelKeys : Bool = false) : String toRsconf

Class methods inherited from class Object

fromRsconf(toplevel : RemiLib::RSConf::RSValue)
fromRsconf(data : String | IO | Path) fromRsconf

Instance Method Detail

def oneOf : Array(String) #

A list of values that the argument is allowed to take. If the user provides a value that does not match any of these, an ArgumentError is raised during parsing.


[View source]
def oneOf=(oneOf : Array(String)) #

A list of values that the argument is allowed to take. If the user provides a value that does not match any of these, an ArgumentError is raised during parsing.


[View source]
def setValue!(val : String) : Nil #

Sets the value of the argument. This does not set #called? to true, and does not check #oneOf.


[View source]
def setValue!(val) : Nil #

:inherit:


[View source]
def str : String #

Returns the value of the argument. This is interchangeable with #value for the StringArgument class.


[View source]
def value : String #

Returns the value of the argument.


[View source]
def value=(val : String) #

Sets the value of the argument. This also sets #called? to true.


[View source]
def value=(val) : Nil #

Sets the value of the argument. This also sets #called? to true.


[View source]