Class StreamRegexExtensionsAsync

Extends the class with functionality to asynchronously against and .

Inheritance
Object
StreamRegexExtensionsAsync
Namespace: StreamRegex.Extensions.RegexExtensions
Assembly: StreamRegex.Extensions.dll
Syntax
public static class StreamRegexExtensionsAsync : object

Methods

| Improve this Doc View Source

GetFirstMatchAsync(IEnumerable<Regex>, Stream, StreamRegexOptions)

Find the first StreamRegexMatch for any of the in a . RegexCache is a recommended to use with this extension method.

Declaration
public static async Task<StreamRegexMatch> GetFirstMatchAsync(this IEnumerable<Regex> engines, Stream streamToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
IEnumerable<Regex> engines

The to operate with
Stream streamToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<StreamRegexMatch>

A StreamRegexMatch object representing the first match, or lack of match.
| Improve this Doc View Source

GetFirstMatchAsync(IEnumerable<Regex>, StreamReader, StreamRegexOptions)

Find the first StreamRegexMatch for any of the in a . RegexCache is a recommended to use with this extension method. Find the first StreamRegexMatch for a in a .

Declaration
public static async Task<StreamRegexMatch> GetFirstMatchAsync(this IEnumerable<Regex> engines, StreamReader streamReaderToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
IEnumerable<Regex> engines

The to operate with
StreamReader streamReaderToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<StreamRegexMatch>

A StreamRegexMatch object representing the first match, or lack of match.
| Improve this Doc View Source

GetFirstMatchAsync(Regex, Stream, StreamRegexOptions)

Find the first StreamRegexMatch for a in a .

Declaration
public static async Task<StreamRegexMatch> GetFirstMatchAsync(this Regex engine, Stream streamToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
Regex engine

The Regex to operate with
Stream streamToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<StreamRegexMatch>

A StreamRegexMatch object representing the first match, or lack of match.
| Improve this Doc View Source

GetFirstMatchAsync(Regex, StreamReader, StreamRegexOptions)

Find the first StreamRegexMatch for a in a .

Declaration
public static async Task<StreamRegexMatch> GetFirstMatchAsync(this Regex engine, StreamReader streamReaderToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
Regex engine

The to operate with
StreamReader streamReaderToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<StreamRegexMatch>

A StreamRegexMatch object representing the first match, or lack of match.
| Improve this Doc View Source

GetMatchCollectionAsync(IEnumerable<Regex>, StreamReader, StreamRegexOptions)

Find all matches for the engines in the set of regexes, for example a RegexCache

Declaration
public static async Task<SlidingBufferMatchCollection<SlidingBufferMatch>> GetMatchCollectionAsync(this IEnumerable<Regex> engines, StreamReader toMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
IEnumerable<Regex> engines

The Regexes to operate with
StreamReader toMatch

The StreamReader to match
StreamRegexOptions options

The StreamRegexOptions to use.
Returns
Type Description
Task<SlidingBufferMatchCollection<SlidingBufferMatch>>

A SlidingBufferMatchCollection<T> containing unique matches. This object will be empty if there are no matches.
| Improve this Doc View Source

GetMatchCollectionAsync(Regex, Stream, StreamRegexOptions)

Find all matches for a given

Declaration
public static async Task<SlidingBufferMatchCollection<SlidingBufferMatch>> GetMatchCollectionAsync(this Regex engine, Stream toMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
Regex engine

The Regex to operate with
Stream toMatch

The StreamReader to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<SlidingBufferMatchCollection<SlidingBufferMatch>>

A SlidingBufferMatchCollection<T> object representing all matches. This object will be empty if there are no matches.
| Improve this Doc View Source

GetMatchCollectionAsync(Regex, StreamReader, StreamRegexOptions)

Find all matches for a given

Declaration
public static async Task<SlidingBufferMatchCollection<SlidingBufferMatch>> GetMatchCollectionAsync(this Regex engine, StreamReader toMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
Regex engine

The Regex to operate with
StreamReader toMatch

The StreamReader to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<SlidingBufferMatchCollection<SlidingBufferMatch>>

A SlidingBufferMatchCollection<T> object representing all matches. This object will be empty if there are no matches.
| Improve this Doc View Source

IsMatchAsync(IEnumerable<Regex>, Stream, StreamRegexOptions)

Find if a matches any of the . RegexCache is a recommended to use with this extension method.

Declaration
public static async Task<bool> IsMatchAsync(this IEnumerable<Regex> engines, Stream streamToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
IEnumerable<Regex> engines

The to operate with
Stream streamToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<Boolean>

True if there is at least one match.
| Improve this Doc View Source

IsMatchAsync(IEnumerable<Regex>, StreamReader, StreamRegexOptions)

Find if a matches any of the . RegexCache is a recommended to use with this extension method.

Declaration
public static async Task<bool> IsMatchAsync(this IEnumerable<Regex> engines, StreamReader streamReaderToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
IEnumerable<Regex> engines

The to operate with
StreamReader streamReaderToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<Boolean>

True if there is at least one match otherwise false.
| Improve this Doc View Source

IsMatchAsync(Regex, Stream, StreamRegexOptions)

Find if a matches a .

Declaration
public static async Task<bool> IsMatchAsync(this Regex engine, Stream streamToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
Regex engine

The to operate with
Stream streamToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<Boolean>

True if there is at least one match.
| Improve this Doc View Source

IsMatchAsync(Regex, StreamReader, StreamRegexOptions)

Find if a matches a regular expression.

Declaration
public static async Task<bool> IsMatchAsync(this Regex engine, StreamReader streamReaderToMatch, StreamRegexOptions options = null)
Parameters
Type Name Description
Regex engine

The to operate with
StreamReader streamReaderToMatch

The to match
StreamRegexOptions options

The StreamRegexOptions to use
Returns
Type Description
Task<Boolean>

A StreamRegexMatch object representing the first match, or lack of match.