Class PluginResult<T>

Namespace

FoundationaLLM.Common.Models.Plugins

Assembly

FoundationaLLM.Common.dll

The result of an operation executed by a plugin.

public record PluginResult<T> : PluginResult, IEquatable<PluginResult>, IEquatable<PluginResult<T>> where T : class

Type Parameters

T

Inheritance

object

PluginResult

PluginResult<T>

Implements

IEquatable<PluginResult>

IEquatable<PluginResult<T>>

Inherited Members

PluginResult.Success

PluginResult.StopProcessing

PluginResult.ErrorMessage

PluginResult.WarningMessage

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Remarks

If StopProcessing is true, the caller of the plugin should not attempt again to ask the plugin to process the same work item. The plugin will set this property to true if it has identified a permanent error that will not be resolved by retrying the operation.

Constructors

PluginResult(T?, bool, bool, string?)

The result of an operation executed by a plugin.

public PluginResult(T? Value, bool Success, bool StopProcessing, string? ErrorMessage = null)

Parameters

Value T

The result of the operation.

Success bool

Indicates whether the operation executed successfully or not.

StopProcessing bool

Indicates whether further processing should stop or not.

ErrorMessage string

When IsSuccess is false, contains an error message with details.

Remarks

If StopProcessing is true, the caller of the plugin should not attempt again to ask the plugin to process the same work item. The plugin will set this property to true if it has identified a permanent error that will not be resolved by retrying the operation.

Properties

Value

The result of the operation.

public T? Value { get; init; }

Property Value

T