Class AuthChallenge

Namespace

Trellis

Assembly

Trellis.Core.dll

Represents a single HTTP authentication challenge (RFC 9110 §11.6.1) carried by Error.Unauthorized. Multiple challenges may be combined to round-trip the full WWW-Authenticate header.

public sealed record AuthChallenge : IEquatable<AuthChallenge>

Inheritance

object

AuthChallenge

Implements

IEquatable<AuthChallenge>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MaybeExtensions.AsMaybe<T>(T)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Func<Error>)

NullableExtensions.ToResult<T>(T?, Error)

AggregateTestMutator.ClearMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>)

AggregateTestMutator.SetMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>, TValue?)

Constructors

AuthChallenge(string, ImmutableDictionary<string, string>?)

Represents a single HTTP authentication challenge (RFC 9110 §11.6.1) carried by Error.Unauthorized. Multiple challenges may be combined to round-trip the full WWW-Authenticate header.

public AuthChallenge(string Scheme, ImmutableDictionary<string, string>? Params = null)

Parameters

Scheme string

The auth scheme (e.g. "Bearer", "Basic").

Params ImmutableDictionary<string, string>

Optional parameters for the challenge (e.g. realm, scope, error). Compared by value contents; parameter order is not significant.

Properties

Params

Optional parameters for the challenge (e.g. realm, scope, error). Compared by value contents; parameter order is not significant.

public ImmutableDictionary<string, string>? Params { get; init; }

Property Value

ImmutableDictionary<string, string>

Scheme

The auth scheme (e.g. "Bearer", "Basic").

public string Scheme { get; init; }

Property Value

string

Methods

Equals(AuthChallenge?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(AuthChallenge? other)

Parameters

other AuthChallenge

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.