StuceSoftware.RandomStringGenerator 2.0.0-prerelease.10

StuceSoftware.RandomStringGenerator

Authors : Jeff Shergalis
Lakhya Jyoti Nath (ljnath)

Date : September 2020 - October 2024

Introduction

StuceSoftware.RandomStringGenerator is a library developed in C# to generate random strings of from various categories. It is fast and suports string generation of various length. It is parameterized to generate both a single or a list of random strings.
Random strings can be of types lowercase, uppercase, numbers and symbols. It also allows you to generate random string with only a subset of symbols from the supported list. It is an ideal library for use in projects such as:

• password generator
• unique-id generator
• unique filename generator
• raw data generator for data processing/parsing projects
• *etc. etc.

Features

• Supports single or multiple random string generation
• Supports random string generation from alphabet, numbers, symbols or a combination of them
• Supports customized length of random string
• Supports random length of generated strings with a fixed max length
• Supports true unique random number generation
• Support force inclusion of strings of each type
• Supports .NET Standard 2.0 & 2.1, .NET 6.0, 8.0 & 9.0

Supported Types

• Lowercase : abcdefghijklmnopqrstuvwxyz
• Uppercase : ABCDEFGHIJKLMNOPQRSTUVWXYZ
• Numbers : 0123456789
• Symbols : !#$%&'()*+,-./:;<=>?@[]^_`{|}~"

These types are defined by an enum CharClasses which has the [Flags] attribue, making it easy to combine the different classes.

:rotating_light: Breaking Change 🚨
The switch to a [Flags] enum is a breaking change in version 2.0

Get Started

1. Install Package

PM> Install-Package StuceSoftware.RandomStringGenerator

2. Add reference in your project

3. Call the methods in your program

using StuceSoftware.RandomStringGenerator;

// generating one random string from lowercase alphabets
var randomString = RandomString.GetString(CharClasses.Lowercase);
System.Console.WriteLine(randomString);

// generating 100 random string from all mixedcase alphabet, numbers and all supported symbols
var randomAlphaNumbericStrings = RandomString.GetStrings(CharClasses.Lowercase | CharClasses.Uppercase | CharClasses.Numbers | CharClasses.Symbols, 100);
foreach (string s in randomAlphaNumbericStrings)
    System.Console.WriteLine(s);

// generating 200 random string from uppercase alphabet with custom symbols
var randomAlphabetWithCustomSymbols = RandomString.GetStrings(CharClasses.Uppercase, 200, "/+*-");
foreach (string s in randomAlphabetWithCustomSymbols)
    System.Console.WriteLine(s);

// generating 1000 true random strings of length 20 from uppercase alphabet with custom symbols
var trueUniqueRandomStrings = RandomString.GetStrings(CharClasses.Uppercase, 1000, 20, "/+*-", false, true);
foreach (string s in trueUniqueRandomStrings)
    System.Console.WriteLine(s);

// generating 100 random string of mixedcase alphanummeric with custom symbols
var randomAlphabetWithCustomSymbols = RandomString.GetStrings(CharClasses.Lowercase | CharClasses.Uppercase | CharClasses.Numbers | CharClasses.Symbols, 100, "/+*-", forceOccuranceOfEachType: true);
foreach (string s in randomAlphabetWithCustomSymbols)
    System.Console.WriteLine(s);

:eyes: Note
As of version 2.0, if custom symbols are defined, there is no need to specify the symbol character class (CharClasses.Symbols), this is assumed when custom symbols are provided

Give a Star! ⭐️

If you find this repository useful, please give it a star. Thanks in advance !

License

Copyright © 2024 Stuce Software Solutions under the MIT License.