Struct RequiredCredential 

pub struct RequiredCredential {
    pub kind: Option<CredentialKind>,
    pub scopes: Vec<Scope>,
    pub site_hint: Option<AttachmentSite>,
}

What a method requires on input — the implicit-derivation projection of scope tagging and credential-graph linkage onto a per-method filter.

Pinned by AUTHZ-CRED-S01-output.md §4 (Q-SELECT-1 resolution: implicit derivation from scope tagging plus refresh/revoke linkage) and AUTHZ-CRED-CORE-3 §“Implicit derivation”. This ticket explicitly does NOT add a #[plexus::method(requires_credential = { .. })] attribute surface — the proposal from AUTHZ-CRED-S01-output §10 is superseded by the implicit-derivation approach pinned here.

Matching semantics (consumer-side)

A candidate credential matches this RequiredCredential iff:

1. kind: if Some(k), the candidate’s CredentialMetadata.kind matches k (or the kind-subsumption table per AUTHZ-CRED-CORE-1 accepts the substitution; e.g. OauthAccess <: Bearer). If None, any kind whose scope set matches is acceptable.
2. scopes: each scope in this set must be wildcard-matched by the candidate’s CredentialMetadata.scopes. The wildcard rules belong to the Scope type itself.
3. site_hint: when populated, prefers the candidate whose CredentialMetadata.attach_as equals the hint. Advisory only — a candidate without the hint is not rejected.

Wire back-compat

Added in AUTHZ-CRED-CORE-3. Pre-existing readers tolerate requires_credential: null (omitted on the wire when None) and pre-existing IRs that omit the field altogether decode cleanly via #[serde(default)] on the field site.

Fields

kind: Option<CredentialKind>

Specific kind a candidate credential must have (e.g., OauthRefresh), or None for “any kind whose scope set matches”.

scopes: Vec<Scope>

Required scope set. A candidate credential’s metadata scopes must wildcard-match each scope in this set.

site_hint: Option<AttachmentSite>

Preferred attach site for the client to use when the candidate credential has multiple alternates. Advisory only.

Implementations

impl RequiredCredential

pub fn from_method_scope(scope: Scope) -> Self

Derive a RequiredCredential from a method’s required scope tagging (per AUTHZ-S01-output §4). The kind field is left None — any kind whose scope set wildcard-matches scope is acceptable.

Used when a method declares #[plexus::method(scope = "...")] (or the framework derives an implicit scope from the method’s path).

pub fn from_refresh_revoke_target( kind: CredentialKind, scopes: Vec<Scope>, ) -> Self

Derive a RequiredCredential for a method that appears as the target of another credential’s metadata.refresh_via or metadata.revoke_via (per AUTHZ-CRED-CORE-3 §“Implicit derivation” row 3). The kind field narrows to the issuing credential’s kind so the selection step picks the right kind (e.g., OauthRefresh for the auth.refresh call on an OauthAccess credential per the OAuth flow described in AUTHZ-CRED-S01-output §7.2).

Trait Implementations

impl Clone for RequiredCredential

fn clone(&self) -> RequiredCredential

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequiredCredential

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RequiredCredential

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RequiredCredential

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RequiredCredential

fn eq(&self, other: &RequiredCredential) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RequiredCredential

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RequiredCredential

impl StructuralPartialEq for RequiredCredential