SpanPolyfillExtensionStartsWith(Span`1Char, String, StringComparison) Method

Indicates whether a character span begins with a specified String when compared using a specified StringComparison value.

Definition

Namespace: FolkerKinzel.Strings
Assembly: FolkerKinzel.Strings (in FolkerKinzel.Strings.dll) Version: 9.4.0+10a7d4d71aa960998e32ac0ac6c4fcbe4164c917

C#

public static bool StartsWith(
	this Span<char> span,
	string? value,
	StringComparison comparisonType
)

VB

<ExtensionAttribute>
Public Shared Function StartsWith ( 
	span As Span(Of Char),
	value As String,
	comparisonType As StringComparison
) As Boolean

C++

public:
[ExtensionAttribute]
static bool StartsWith(
	Span<wchar_t> span, 
	String^ value, 
	StringComparison comparisonType
)

F#

[<ExtensionAttribute>]
static member StartsWith : 
        span : Span<char> * 
        value : string * 
        comparisonType : StringComparison -> bool

Parameters

span SpanChar: The source span.
value String: The String to compare with the beginning of the source span.
comparisonType StringComparison: An enumeration value that determines how span and value are compared.

Return Value

Boolean
true if value matches the beginning of span, otherwise false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type SpanChar. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

If value is null or Empty the method returns true.

Exceptions

ArgumentException

comparisonType is not a defined value of the StringComparison enum.