StringValues Struct

Definition

Namespace:

Microsoft.Extensions.Primitives

Assembly:

Microsoft.Extensions.Primitives.dll

Package:

Microsoft.Extensions.Primitives v9.0.0

Source:

StringValues.cs

Represents zero/null, one, or many strings in an efficient way.

public value class StringValues : IEquatable<cli::array <System::String ^> ^>, IEquatable<Microsoft::Extensions::Primitives::StringValues>, IEquatable<System::String ^>, System::Collections::Generic::ICollection<System::String ^>, System::Collections::Generic::IEnumerable<System::String ^>, System::Collections::Generic::IList<System::String ^>, System::Collections::Generic::IReadOnlyCollection<System::String ^>, System::Collections::Generic::IReadOnlyList<System::String ^>

public readonly struct StringValues : IEquatable<Microsoft.Extensions.Primitives.StringValues>, IEquatable<string[]>, IEquatable<string>, System.Collections.Generic.ICollection<string>, System.Collections.Generic.IEnumerable<string>, System.Collections.Generic.IList<string>, System.Collections.Generic.IReadOnlyCollection<string>, System.Collections.Generic.IReadOnlyList<string>

type StringValues = struct
    interface IList<string>
    interface ICollection<string>
    interface seq<string>
    interface IEnumerable
    interface IReadOnlyList<string>
    interface IReadOnlyCollection<string>

Public Structure StringValues
Implements ICollection(Of String), IEnumerable(Of String), IEquatable(Of String()), IEquatable(Of String), IEquatable(Of StringValues), IList(Of String), IReadOnlyCollection(Of String), IReadOnlyList(Of String)

Inheritance

Object

ValueType

StringValues

Implements

ICollection<String> ICollection<T> IEnumerable<String> IEnumerable<T> IList<String> IReadOnlyCollection<String> IReadOnlyCollection<T> IReadOnlyList<String> IEnumerable IEquatable<StringValues> IEquatable<String[]> IEquatable<String>

Constructors

StringValues(String)	Initializes a new instance of the StringValues structure using the specified string.
StringValues(String[])	Initializes a new instance of the StringValues structure using the specified array of strings.

Fields

Empty

A readonly instance of the StringValues struct whose value is an empty string array.

Properties

Count	Gets the number of String elements contained in this StringValues.
Item[Int32]	Gets the String at the specified index.

Methods

Concat(String, StringValues)	Concatenates specified instance of String with specified StringValues.
Concat(StringValues, String)	Concatenates specified instance of StringValues with specified String.
Concat(StringValues, StringValues)	Concatenates two specified instances of StringValues.
Equals(Object)	Determines whether this instance and a specified object have the same value.
Equals(String, StringValues)	Determines whether the specified String and StringValues objects have the same values.
Equals(String)	Determines whether this instance and a specified String, have the same value.
Equals(String[], StringValues)	Determines whether the specified string array and StringValues objects have the same values.
Equals(String[])	Determines whether this instance and a specified string array have the same values.
Equals(StringValues, String)	Determines whether the specified StringValues and String objects have the same values.
Equals(StringValues, String[])	Determines whether the specified StringValues and string array objects have the same values.
Equals(StringValues, StringValues)	Determines whether two specified StringValues objects have the same values in the same order.
Equals(StringValues)	Determines whether this instance and another specified StringValues object have the same values.
GetEnumerator()	Retrieves an object that can iterate through the individual strings in this StringValues.
GetHashCode()	Returns a hash code for this instance.
IsNullOrEmpty(StringValues)	Indicates whether the specified StringValues contains no string values.
ToArray()	Creates a string array from the current StringValues object.
ToString()	Converts the value of the current StringValues object to its equivalent string representation, with multiple values joined as a comma separated string.

Operators

Equality(Object, StringValues)	Determines whether the specified Object, which must be a StringValues, String, or array of String, and specified StringValues, have the same value.
Equality(String, StringValues)	Determines whether the specified String and StringValues objects have the same values.
Equality(String[], StringValues)	Determines whether the specified string array and StringValues objects have the same values.
Equality(StringValues, Object)	Determines whether the specified StringValues and Object, which must be a StringValues, String, or array of String, have the same value.
Equality(StringValues, String)	Determines whether the specified StringValues and String objects have the same values.
Equality(StringValues, String[])	Determines whether the specified StringValues and string array objects have the same values.
Equality(StringValues, StringValues)	Determines whether two specified StringValues have the same values.
Implicit(String to StringValues)	Defines an implicit conversion of a given string to a StringValues.
Implicit(String[] to StringValues)	Defines an implicit conversion of a given string array to a StringValues.
Implicit(StringValues to String)	Defines an implicit conversion of a given StringValues to a string, with multiple values joined as a comma separated string.
Implicit(StringValues to String[])	Defines an implicit conversion of a given StringValues to a string array.
Inequality(Object, StringValues)	Determines whether the specified Object and StringValues object have the same values.
Inequality(String, StringValues)	Determines whether the specified String and StringValues objects have different values.
Inequality(String[], StringValues)	Determines whether the specified string array and StringValues have different values.
Inequality(StringValues, Object)	Determines whether the specified StringValues and Object, which must be a StringValues, String, or array of String, have different values.
Inequality(StringValues, String)	Determines whether the specified StringValues and String objects have different values.
Inequality(StringValues, String[])	Determines whether the specified StringValues and string array have different values.
Inequality(StringValues, StringValues)	Determines whether two specified StringValues have different values.

Explicit Interface Implementations

ICollection<String>.Add(String)	Adds an item to the collection.
ICollection<String>.Clear()	Removes all items from the collection.
ICollection<String>.Contains(String)	Determines whether a string is in the StringValues.
ICollection<String>.CopyTo(String[], Int32)	Copies the entire StringValuesto a string array, starting at the specified index of the target array.
ICollection<String>.IsReadOnly	Gets a value indicating whether the collection is read-only.
ICollection<String>.Remove(String)	Removes the first occurrence of a specific object from the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<String>.GetEnumerator()	Returns an enumerator that iterates through the collection.
IList<String>.IndexOf(String)	Returns the zero-based index of the first occurrence of an item in the StringValues.
IList<String>.Insert(Int32, String)	Inserts an item to the IList<T> at the specified index.
IList<String>.Item[Int32]	Gets the String at the specified index.
IList<String>.RemoveAt(Int32)	Removes the IList<T> item at the specified index.

Extension Methods

ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector function.
ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector and element selector functions.
ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>)	Creates a FrozenSet<T> with the specified values.
ToImmutableArray<TSource>(IEnumerable<TSource>)	Creates an immutable array from the specified collection.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Constructs an immutable dictionary based on some transformation of a sequence.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents.
ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>)	Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type.
ToImmutableHashSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable hash set of its contents.
ToImmutableList<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable list of its contents.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>)	Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable sorted set of its contents.