getopt.net.Extensions Class Reference

Static Public Member Functions
static ? Option	FindOptionOrDefault (this Option[] list, string optName)
	Finds an option with the name optName More...
static ? Option	FindOptionOrDefault (this Option[] list, char optVal)
	Finds an option in the list list with the Option.Value optVal . More...
static ? string	ToShortOptString (this Option[] list)
	Creates a short opt string from an array of Option objects. More...

Detailed Description

This class contains extension methods specific to getopt.net. If these extension methods help you in your program, you're free to use them too!

Definition at line 12 of file Extensions.cs.

Member Function Documentation

FindOptionOrDefault() [1/2]

static ? Option getopt.net.Extensions.FindOptionOrDefault ( this Option[]  list, char  optVal  )

static

Finds an option in the list list with the Option.Value optVal .

Parameters

list	The list of options to search.
optVal	The value to search for.

Returns

The Option with the Option.Value optVal , or

null

if no option was found matching the name.

FindOptionOrDefault() [2/2]

static ? Option getopt.net.Extensions.FindOptionOrDefault ( this Option[]  list, string  optName  )

inlinestatic

Finds an option with the name optName

Parameters

list	The list of options to search.
optName	The name of the argument to search for.

Returns

The Option with the name optName , or

null

if no option was found matching the name.

Definition at line 20 of file Extensions.cs.

                                                                                      {
            if (string.IsNullOrEmpty(optName)) { throw new ArgumentNullException(nameof(optName), "optName must not be null!"); }
 
            return list.FirstOrDefault(o => o.Name?.Equals(optName, StringComparison.InvariantCulture) == true);
        }

ToShortOptString()

static ? string getopt.net.Extensions.ToShortOptString ( this Option[]  list )

inlinestatic

Creates a short opt string from an array of Option objects.

Parameters

list	The options to convert.

Returns

null

if the option list is empty or null. A string contain a shortopt-form string representing all the options from list .

Definition at line 39 of file Extensions.cs.

                                                                   {
            if (list is null || list.Length == 0) { return null; }
 
            var sBuilder = new StringBuilder();
 
            foreach (var opt in list) {
                sBuilder.Append((char)opt.Value);
                switch (opt.ArgumentType) {
                    case ArgumentType.Required:
                        sBuilder.Append(':');
                        break;
                    case ArgumentType.Optional:
                        sBuilder.Append(';');
                        break;
                    default: break;
                }
            }
 
            return sBuilder.ToString();
        }

---

The documentation for this class was generated from the following file:

• Extensions.cs