Class ForbiddenError

Namespace

REslava.Result

Assembly

REslava.Result.dll

Represents an authorization error (HTTP 403 equivalent). Use when the caller is authenticated but lacks permission.

public class ForbiddenError : Reason<ForbiddenError>, IReasonMetadata, IError, IReason, IErrorFactory<ForbiddenError>

Inheritance

object

Reason

Reason<ForbiddenError>

ForbiddenError

Implements

IReasonMetadata

IError

IReason

IErrorFactory<ForbiddenError>

Inherited Members

Reason<ForbiddenError>.WithMessage(string)

Reason<ForbiddenError>.WithTag(string, object)

Reason<ForbiddenError>.WithTag<T>(TagKey<T>, T)

Reason<ForbiddenError>.WithTags(params (string key, object value)[])

Reason<ForbiddenError>.WithTagsFrom(ImmutableDictionary<string, object>)

Reason<ForbiddenError>.WithMetadata(ReasonMetadata)

Reason.Message

Reason.Tags

Reason.Metadata

Reason.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

ValidationExtensions.EnsureNotNull<TCollection>(TCollection?, string, string?)

ReasonMetadataExtensions.HasCallerInfo(IReason)

ReasonMetadataExtensions.TryGetMetadata(IReason)

ReasonTagExtensions.Has<T>(IReason, TagKey<T>)

ReasonTagExtensions.TryGet<T>(IReason, TagKey<T>, out T?)

TagAccessExtensions.FormatTags(IReason, string)

TagAccessExtensions.GetTagBool(IReason, string, bool)

TagAccessExtensions.GetTagDecimal(IReason, string, decimal)

TagAccessExtensions.GetTagInt(IReason, string, int)

TagAccessExtensions.GetTagKeys(IReason)

TagAccessExtensions.GetTagString(IReason, string, string)

TagAccessExtensions.GetTag<T>(IReason, string, T?)

TagAccessExtensions.GetTags(IReason)

TagAccessExtensions.HasTag(IReason, string)

TagAccessExtensions.RequireTag<T>(IReason, string)

Examples

Result<User>.Fail(new ForbiddenError());
Result<User>.Fail(new ForbiddenError("Admin role required"));
Result<User>.Fail(ForbiddenError.For("Delete", "Order"));

Constructors

ForbiddenError()

Creates a generic access-denied error. CallerMember is not captured.

public ForbiddenError()

ForbiddenError(string, string)

[Obsolete("Use ForbiddenError.For(action, resource) for access control errors. This constructor will be removed in a future version.")]
public ForbiddenError(string action, string resource)

Parameters

action string

resource string

ForbiddenError(string, string?, string?, int)

public ForbiddenError(string message, string? callerMember = null, string? callerFile = null, int callerLine = 0)

Parameters

message string

callerMember string

callerFile string

callerLine int

Methods

Create(string)

Creates an instance of ForbiddenError with the given message.

public static ForbiddenError Create(string message)

Parameters

message string

Returns

ForbiddenError

CreateNew(string, ImmutableDictionary<string, object>)

Factory method for creating new instances (maintains immutability). Must be implemented by derived classes.

protected override ForbiddenError CreateNew(string message, ImmutableDictionary<string, object> tags)

Parameters

message string

tags ImmutableDictionary<string, object>

Returns

ForbiddenError

For(string, string, string?, string?, int)

Creates an access-denied error for a specific action/resource pair, capturing the calling method name automatically.

public static ForbiddenError For(string action, string resource, string? callerMember = null, string? callerFile = null, int callerLine = 0)

Parameters

action string

resource string

callerMember string

callerFile string

callerLine int

Returns

ForbiddenError