IOUtils 1.7.0

IOUtils: Input and Output Utility Package for .NET

Installation

Install the IOUtils NuGet package using the .NET CLI:

dotnet add package IOUtils

Features

Input retrieval

Retrieve text from the user

TextInput is a class that allows for the retrieval of text from the user.

using IOUtils.Input;

string text = TextInput.GetText("Enter some text");
string nonEmptyText = TextInput.GetNonEmptyText("Enter some (non-empty) text");

Retrieve number from the user

NumberInput is a generic class that allows for the retrieval of a number from the user. Optionally, a minimum and maximum value can be specified to restrict the input range.

using IOUtils.Input;

int value = NumberInput<int>.GetNumber("Enter a whole number");
long value = NumberInput<long>.GetNumber("Enter a non-negative whole number", min: 0);
float? value = NumberInput<float>.GetOptionalNumber("Enter a negative number (Press enter to skip)", max: 0);
decimal? value = NumberInput<decimal>.GetOptionalNumber("Enter a number between 0 and 100 (Press enter to skip)", min: 0, max: 100);

Retrieve option from the user

OptionInput is a class that allows for the retrieval of an option from the user. Default options can also be provided to make the input more user-friendly.

using IOUtils.Input;

string selectedOption = OptionInput.GetOption("Select an option", ["Option 1", "Option 2", "Option 3"]);
int optionIndex = OptionInput.GetOptionIndex("Select an option", ["Option 1", "Option 2", "Option 3"]);
bool doSomething = OptionInput.GetYesNoOption("Do you want to do something?");
bool tryAgain = OptionInput.GetEitherOrOption("What do you want to do?", "Try again", "Exit");

using IOUtils.Input;

string selectedOption = OptionInput.GetOption("Select an option", ["Option 1", "Option 2", "Option 3"], defaultOption: "Option 2");
int optionIndex = OptionInput.GetOptionIndex("Select an option", ["Option 1", "Option 2", "Option 3"], defaultOption: "Option 3");
bool doSomething = OptionInput.GetYesNoOption("Do you want to do something?", defaultOption: true);
bool tryAgain = OptionInput.GetEitherOrOption("What do you want to do?", "Try again", "Exit", defaultOption: true);

Alternatively, a dictionary can be used to map descriptions to values.

using IOUtils.Input;

Dictionary<string, int> options = new() {
    { "Option 1", 1 },
    { "Option 2", 2 },
    { "Option 3", 3 }
};

int selectedOption = OptionInput.GetOption("Select an option", options);
// Again, a default option can be provided if desired
selectedOption = OptionInput.GetOption("Select an option", options, defaultOption: "Option 2");

Console.WriteLine($"Value {selectedOption} returned");

Dictionary<string, Action> actions = new() {
    { "Option 1", () => Console.WriteLine("Option 1 selected") },
    { "Option 2", () => Console.WriteLine("Option 2 selected") },
    { "Option 3", () => Console.WriteLine("Option 3 selected") }
};

OptionInput.GetOption("Select an option", actions)();
OptionInput.GetOption("Select an option", actions, defaultOption: "Option 1")();

Retrieve file path from the user

FileInput is a class that allows for the retrieval of an existing file or directory path from the user.

using IOUtils.Input;

string filePath = FileInput.GetFilePath("Enter a file path");
string directoryPath = FileInput.GetDirectoryPath("Enter a directory path");

Encoding

Available encodings

The following encoders are available:

Encode text

Encode a byte array using one of the available encoders. The encoded text is returned as a string.

using IOUtils.Data;

byte[] raw = "Hello, World!"u8.ToArray();

// Any encoder listed above can be used here
string encoded = Encoder.Base36.Encode(raw);

Console.WriteLine($"Encoded text: {encoded}");

To check if a byte array requires encoding, the RequiresEncoding method can be used:

using IOUtils.Data;

byte[] raw = "Hello, World!"u8.ToArray();

bool requiresEncoding = Encoder.Base36.RequiresEncoding(raw);

Decode text

Decode a string encoded using one of the available encoders. The decoded text is returned as a byte array. If the encoded text is not valid, a FormatException is thrown.

using IOUtils.Data;

string encoded = "FG3H7VQW7EEN6JWWNZMP";

byte[] decoded = Encoder.Base36.Decode(encoded);

Console.WriteLine($"Decoded text: {System.Text.Encoding.UTF8.GetString(decoded)}");

Contributions

Contributions are welcome! Read the CONTRIBUTING guide for information.

License

This project is licensed under the MIT License. See the LICENSE for details.