Class StreamRegexExtensions

Extends the class with functionality to check against and .

Inheritance

Object

StreamRegexExtensions

Namespace: StreamRegex.Extensions.RegexExtensions

Assembly: StreamRegex.Extensions.dll

Syntax

public static class StreamRegexExtensions : object

Methods

GetFirstMatch(IEnumerable<Regex>, Stream, StreamRegexOptions)

Find if a matches any of a number of .

Declaration

public static StreamRegexMatch GetFirstMatch(this IEnumerable<Regex> engines, Stream toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
IEnumerable<Regex>	engines	The to check against the Stream
Stream	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
StreamRegexMatch	A StreamRegexMatch object representing the first, or lack of, Match.

GetFirstMatch(IEnumerable<Regex>, StreamReader, StreamRegexOptions)

Find if a matches any of a number of .

Declaration

public static StreamRegexMatch GetFirstMatch(this IEnumerable<Regex> engines, StreamReader toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
IEnumerable<Regex>	engines	The to check against the Stream
StreamReader	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
StreamRegexMatch	A StreamRegexMatch object representing the first, or lack of, Match.

GetFirstMatch(Regex, Stream, StreamRegexOptions)

Find the first match for a in a .

Declaration

public static StreamRegexMatch GetFirstMatch(this Regex engine, Stream toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
Regex	engine	The to operate with
Stream	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
StreamRegexMatch	A StreamRegexMatch object representing the first, or lack of, Match.

GetFirstMatch(Regex, StreamReader, StreamRegexOptions)

Find if a matches a .

Declaration

public static StreamRegexMatch GetFirstMatch(this Regex engine, StreamReader toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
Regex	engine	The to operate with
StreamReader	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
StreamRegexMatch	A StreamRegexMatch object representing the first, or lack of, Match.

GetMatchCollection(IEnumerable<Regex>, StreamReader, StreamRegexOptions)

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

Declaration

public static SlidingBufferMatchCollection<StreamRegexMatch> GetMatchCollection(this IEnumerable<Regex> engines, StreamReader toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
IEnumerable<Regex>	engines	The to operate with
StreamReader	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use.

Returns

Type	Description
SlidingBufferMatchCollection<StreamRegexMatch>	A SlidingBufferMatchCollection<T> containing unique matches. This collection will be empty if there are no matches.

GetMatchCollection(Regex, Stream, StreamRegexOptions)

Find all matches for a given

Declaration

public static SlidingBufferMatchCollection<StreamRegexMatch> GetMatchCollection(this Regex engine, Stream toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
Regex	engine	The Regex to operate with
Stream	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
SlidingBufferMatchCollection<StreamRegexMatch>	A SlidingBufferMatchCollection<T> object representing all matches. This collection will be empty if there are no matches.

GetMatchCollection(Regex, StreamReader, StreamRegexOptions)

Find all matches for a given

Declaration

public static SlidingBufferMatchCollection<StreamRegexMatch> GetMatchCollection(this Regex engine, StreamReader toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
Regex	engine	The to operate with
StreamReader	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
SlidingBufferMatchCollection<StreamRegexMatch>	A SlidingBufferMatchCollection<T> object representing all matches. This collection will be empty if there are no matches.

IsMatch(IEnumerable<Regex>, Stream, StreamRegexOptions)

Find if a matches any of the in a set.

Declaration

public static bool IsMatch(this IEnumerable<Regex> engines, Stream toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
IEnumerable<Regex>	engines	The to check against the
Stream	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
Boolean	True if there is at least one match.

IsMatch(IEnumerable<Regex>, StreamReader, StreamRegexOptions)

Find if a matches any of the in a set.

Declaration

public static bool IsMatch(this IEnumerable<Regex> engines, StreamReader toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
IEnumerable<Regex>	engines	The to operate with
StreamReader	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
Boolean	True if there is at least one match.

IsMatch(Regex, Stream, StreamRegexOptions)

Find if a Stream matches a regular expression.

Declaration

public static bool IsMatch(this Regex engine, Stream toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
Regex	engine	The to operate with
Stream	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
Boolean	True if there is at least one match.

IsMatch(Regex, StreamReader, StreamRegexOptions)

Find if a matches a .

Declaration

public static bool IsMatch(this Regex engine, StreamReader toMatch, StreamRegexOptions options = null)

Parameters

Type	Name	Description
Regex	engine	The to operate with
StreamReader	toMatch	The to match
StreamRegexOptions	options	The StreamRegexOptions to use

Returns

Type	Description
Boolean	True if there is at least one match.