Class RegexCommandMatchResult

Represents results of a check whether a Regex Command should run.

Inheritance

System.Object

RegexCommandMatchResult

Implements

ICommandResult

Namespace: TehGM.Wolfringo.Commands.Results

Assembly: Wolfringo.Commands.dll

Syntax

public class RegexCommandMatchResult : ICommandResult

Constructors

RegexCommandMatchResult(CommandResultStatus, Match, CommandContextOptions)

Creates a new result instance.

Declaration

public RegexCommandMatchResult(CommandResultStatus status, Match regexMatch, CommandContextOptions options)

Parameters

Type	Name	Description
CommandResultStatus	status	Status telling Command Service how to proceed.
System.Text.RegularExpressions.Match	regexMatch	Result of regex match.
CommandContextOptions	options	Options for command context, with command's overrides applied.

Fields

Skip

Shared failure result.

Declaration

public static readonly RegexCommandMatchResult Skip

Field Value

Type	Description
RegexCommandMatchResult

Properties

IsSuccess

Whether execution or check was successful.

Declaration

[Obsolete("Use Status property instead.")]
public bool IsSuccess { get; }

Property Value

Type	Description
System.Boolean

Remarks

This property has been obsoleted in favour of Status and will be removed in future updates.

Options

Options for command context, with command's overrides applied.

Declaration

public CommandContextOptions Options { get; }

Property Value

Type	Description
CommandContextOptions

RegexMatch

Result of regex match.

Declaration

public Match RegexMatch { get; }

Property Value

Type	Description
System.Text.RegularExpressions.Match

Status

Status telling commands service how to progress with the execution.

Declaration

public CommandResultStatus Status { get; }

Property Value

Type	Description
CommandResultStatus

Methods

Success(Match, CommandContextOptions)

Creates a success result.

Declaration

public static RegexCommandMatchResult Success(Match regexMatch, CommandContextOptions options)

Parameters

Type	Name	Description
System.Text.RegularExpressions.Match	regexMatch	Result of regex match.
CommandContextOptions	options	Options for command context, with command's overrides applied.

Returns

Type	Description
RegexCommandMatchResult

Implements

ICommandResult