Class TermReader

Terminal input reader module

Inheritance
object
TermReader
Namespace
Terminaux.Reader @ Terminaux.dll
Syntax
public static class TermReader


Properties

GlobalReaderSettings

The global reader settings

Property Value
TermReaderSettings
Declaration
public static TermReaderSettings GlobalReaderSettings { get; }

IsReaderBusy

Is the terminal reader busy? It's not the same as Busy, because it only checks the reader and not the entire input system.

Property Value
bool
Declaration
public static bool IsReaderBusy { get; }


Methods

Read(bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(Func<string>, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(Func<string> inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(Func<string>, string, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(Func<string> inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
defaultValue string

Default value to use if no input is provided
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(Func<string>, string, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(Func<string> inputPrompt, string defaultValue, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
defaultValue string

Default value to use if no input is provided
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(Func<string>, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(Func<string> inputPrompt, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(string, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(string inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt string

The input to be read
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(string, string, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(string inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt string

The input to be read
defaultValue string

Default value to use if no input is provided
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(string, string, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(string inputPrompt, string defaultValue, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt string

The dynamic input function to prompt the user
defaultValue string

Default value to use if no input is provided
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(string, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(string inputPrompt, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
inputPrompt string

The input to be read
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read(TermReaderSettings, bool, bool, bool)

Reads the input

Returns
string
Declaration
public static string Read(TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)
Parameters
Name Type Description
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not

Read<T>(bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(Func<string>, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(Func<string> inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(Func<string>, string, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(Func<string> inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
defaultValue string

Default value to use if no input is provided
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(Func<string>, string, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(Func<string> inputPrompt, string defaultValue, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
defaultValue string

Default value to use if no input is provided
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(Func<string>, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(Func<string> inputPrompt, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt Func<string>

The dynamic input function to prompt the user
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(string, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(string inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt string

The input to be read
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(string, string, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(string inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt string

The input to be read
defaultValue string

Default value to use if no input is provided
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(string, string, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(string inputPrompt, string defaultValue, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt string

The dynamic input function to prompt the user
defaultValue string

Default value to use if no input is provided
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(string, TermReaderSettings, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(string inputPrompt, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
inputPrompt string

The input to be read
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Read<T>(TermReaderSettings, bool, bool, bool)

Reads the input

Returns
T
Declaration
public static T Read<T>(TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible
Parameters
Name Type Description
settings TermReaderSettings

Settings containing reader-related settings
password bool

Whether the password mode is enabled
oneLineWrap bool

Whether to wrap overflown text as one line
interruptible bool

Whether the prompt is interruptible or not
Type Parameters
Name Description
T

Table of contents



    About

    © 2014-2026 Aptivi

    Find us

  •  
  •  
  •  
  •  
  •  
  •  

    • Social media

  •  
  •  
  •  
  •