Class SlidingBufferMatch

A match on the sliding buffer that includes the Value which was matched.

Inheritance

Object

SlidingBufferMatch

StreamRegexMatch

Implements

IEquatable<SlidingBufferMatch>

Namespace: StreamRegex.Extensions

Assembly: StreamRegex.Extensions.dll

Syntax

public class SlidingBufferMatch : object

Constructors

SlidingBufferMatch(Boolean, Int64, Int64, Nullable<String>)

A match on the sliding buffer that includes the Value which was matched.

Declaration

public SlidingBufferMatch(bool Success = false, long Index = null, long Length = null, string? Value = null)

Parameters

Type	Name	Description
Boolean	Success	If the match was successful
Int64	Index	The position offset in the stream relative to the start when provided, or -1 if Success is false
Int64	Length	The length of the match in the stream, or -1 if Success is false
Nullable<String>	Value	The content that was matched, or null if Success is false or if CaptureValues is false.

Properties

Index

The index in the Stream where the match was found

Declaration

public long Index { get; }

Property Value

Type	Description
Int64

Length

Declaration

public long Length { get; set; }

Property Value

Type	Description
Int64

Success

Declaration

public bool Success { get; set; }

Property Value

Type	Description
Boolean

Value

Declaration

public string? Value { get; set; }

Property Value

Type	Description
Nullable<String>

Implements

System.IEquatable<T>