Files
anthropic-client/src/AnthropicClient/Models/AnthropicResult.cs
T

67 lines
2.2 KiB
C#
Raw Normal View History

2024-06-27 23:26:53 -05:00
using AnthropicClient.Models;
/// <summary>
/// Represents the result of an Anthropic API operation.
/// </summary>
/// <typeparam name="T">The type of the result value.</typeparam>
public class AnthropicResult<T>
{
/// <summary>
/// The value of the result.
/// </summary>
public T Value { get; }
/// <summary>
/// The error of the result.
/// </summary>
public AnthropicError Error { get; }
/// <summary>
/// Indicates whether the operation was successful.
/// </summary>
public bool IsSuccess { get; }
/// <summary>
/// The request ID of the operation.
/// </summary>
public AnthropicHeaders Headers { get; }
2024-06-27 23:26:53 -05:00
/// <summary>
/// Initializes a new instance of the <see cref="AnthropicResult{T}"/> class.
/// </summary>
/// <param name="value">The value of the result.</param>
/// <param name="error">The error of the result.</param>
/// <param name="isSuccess">Indicates whether the operation was successful.</param>
/// <param name="headers">The Anthropic headers for the result.</param>
2024-06-27 23:26:53 -05:00
/// <returns>A new instance of the <see cref="AnthropicResult{T}"/> class.</returns>
protected AnthropicResult(T value, AnthropicError error, bool isSuccess, AnthropicHeaders headers)
2024-06-27 23:26:53 -05:00
{
Value = value;
Error = error;
IsSuccess = isSuccess;
Headers = headers;
2024-06-27 23:26:53 -05:00
}
/// <summary>
/// Creates a successful result.
/// </summary>
/// <param name="value">The value of the result.</param>
/// <param name="headers">The Anthropic headers for the result.</param>
2024-06-27 23:26:53 -05:00
/// <returns>A new instance of the <see cref="AnthropicResult{T}"/> class.</returns>
public static AnthropicResult<T> Success(T value, AnthropicHeaders headers)
2024-06-27 23:26:53 -05:00
{
return new AnthropicResult<T>(value, null!, true, headers);
2024-06-27 23:26:53 -05:00
}
/// <summary>
/// Creates a failed result.
/// </summary>
/// <param name="error">The error of the result.</param>
/// <param name="headers">The Anthropic headers for the result.</param>
2024-06-27 23:26:53 -05:00
/// <returns>A new instance of the <see cref="AnthropicResult{T}"/> class.</returns>
public static AnthropicResult<T> Failure(AnthropicError error, AnthropicHeaders headers)
2024-06-27 23:26:53 -05:00
{
return new AnthropicResult<T>(default!, error, false, headers);
2024-06-27 23:26:53 -05:00
}
}