Class TermReader

Terminal input reader module

Inheritance

object

TermReader

Namespace: Terminaux.Reader

Assembly: Terminaux.dll

Syntax

public static class TermReader

Properties

| Edit this page View Source

GlobalReaderSettings

The global reader settings

Declaration

public static TermReaderSettings GlobalReaderSettings { get; }

Property Value

Type	Description
TermReaderSettings

| Edit this page View Source

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.

Declaration

public static bool IsReaderBusy { get; }

Property Value

Type	Description
bool

Methods

| Edit this page View Source

Read(bool, bool, bool)

Reads the input

Declaration

public static string Read(bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

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

Reads the input

Declaration

public static string Read(Func<string> inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

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

Reads the input

Declaration

public static string Read(Func<string> inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
string	defaultValue	Default value to use if no input is provided
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

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

Reads the input

Declaration

public static string Read(Func<string> inputPrompt, string defaultValue, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
string	defaultValue	Default value to use if no input is provided
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

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

Reads the input

Declaration

public static string Read(Func<string> inputPrompt, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

Read(string, bool, bool, bool)

Reads the input

Declaration

public static string Read(string inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
string	inputPrompt	The input to be read
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

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

Reads the input

Declaration

public static string Read(string inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
string	inputPrompt	The input to be read
string	defaultValue	Default value to use if no input is provided
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

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

Reads the input

Declaration

public static string Read(string inputPrompt, string defaultValue, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
string	inputPrompt	The dynamic input function to prompt the user
string	defaultValue	Default value to use if no input is provided
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

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

Reads the input

Declaration

public static string Read(string inputPrompt, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
string	inputPrompt	The input to be read
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

Read(TermReaderSettings, bool, bool, bool)

Reads the input

Declaration

public static string Read(TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true)

Parameters

Type	Name	Description
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
string

| Edit this page View Source

Read<T>(bool, bool, bool)

Reads the input

Declaration

public static T Read<T>(bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible

Parameters

Type	Name	Description
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

Declaration

public static T Read<T>(Func<string> inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible

Parameters

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

Declaration

public static T Read<T>(Func<string> inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible

Parameters

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
string	defaultValue	Default value to use if no input is provided
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

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

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
string	defaultValue	Default value to use if no input is provided
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

Declaration

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

Parameters

Type	Name	Description
Func<string>	inputPrompt	The dynamic input function to prompt the user
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

Declaration

public static T Read<T>(string inputPrompt, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible

Parameters

Type	Name	Description
string	inputPrompt	The input to be read
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

Declaration

public static T Read<T>(string inputPrompt, string defaultValue, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible

Parameters

Type	Name	Description
string	inputPrompt	The input to be read
string	defaultValue	Default value to use if no input is provided
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

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

Type	Name	Description
string	inputPrompt	The dynamic input function to prompt the user
string	defaultValue	Default value to use if no input is provided
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

Declaration

public static T Read<T>(string inputPrompt, TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible

Parameters

Type	Name	Description
string	inputPrompt	The input to be read
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

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

Reads the input

Declaration

public static T Read<T>(TermReaderSettings settings, bool password = false, bool oneLineWrap = false, bool interruptible = true) where T : IConvertible

Parameters

Type	Name	Description
TermReaderSettings	settings	Settings containing reader-related settings
bool	password	Whether the password mode is enabled
bool	oneLineWrap	Whether to wrap overflown text as one line
bool	interruptible	Whether the prompt is interruptible or not

Returns

Type	Description
T

Type Parameters

Name	Description
T