Struct PluginCommandResult

Namespace

WTmux.Core.Plugins

Assembly

WTmux.Core.dll

Result of a wtmux command run by a plugin via RunCommand(string).

public readonly struct PluginCommandResult

Constructors

PluginCommandResult(bool, string, string?)

Result of a wtmux command run by a plugin via RunCommand(string).

public PluginCommandResult(bool Success, string Output, string? Error)

Parameters

Success bool

Whether the command completed successfully.

Output string

Any textual output produced by the command (may be empty).

Error string

The error message when Success is false; otherwise null.

Properties

Error

The error message when Success is false; otherwise null.

public string? Error { get; init; }

Property Value

string

Output

Any textual output produced by the command (may be empty).

public string Output { get; init; }

Property Value

string

Success

Whether the command completed successfully.

public bool Success { get; init; }

Property Value

bool

Methods

Deconstruct(out bool, out string, out string?)

public void Deconstruct(out bool Success, out string Output, out string? Error)

Parameters

Success bool

Output string

Error string

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

Equals(PluginCommandResult)

public bool Equals(PluginCommandResult other)

Parameters

other PluginCommandResult

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(PluginCommandResult, PluginCommandResult)

public static bool operator ==(PluginCommandResult left, PluginCommandResult right)

Parameters

left PluginCommandResult

right PluginCommandResult

Returns

bool

operator !=(PluginCommandResult, PluginCommandResult)

public static bool operator !=(PluginCommandResult left, PluginCommandResult right)

Parameters

left PluginCommandResult

right PluginCommandResult

Returns

bool