Class PluginResult

Namespace

FoundationaLLM.Common.Models.Plugins

Assembly

FoundationaLLM.Common.dll

The result of an operation executed by a plugin.

public record PluginResult : IEquatable<PluginResult>

Inheritance

object

PluginResult

Implements

IEquatable<PluginResult>

Derived

PluginResult<T>

Inherited Members

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(bool, bool, string?)

The result of an operation executed by a plugin.

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

Parameters

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

ErrorMessage

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

public string? ErrorMessage { get; init; }

Property Value

string

StopProcessing

Indicates whether further processing should stop or not.

public bool StopProcessing { get; init; }

Property Value

bool

Success

Indicates whether the operation executed successfully or not.

public bool Success { get; init; }

Property Value

bool