Skip to main content

CredentialFieldDecl

Struct CredentialFieldDecl 

Source
pub struct CredentialFieldDecl {
    pub field_path: Vec<String>,
    pub variant_tag: Option<String>,
    pub metadata: CredentialMetadata,
}
Expand description

One entry per credential-bearing field in a method’s return type.

Pinned by AUTHZ-CRED-S01-output.md §4 and AUTHZ-CRED-CORE-3 §“Required behavior”. Projected onto MethodSchema.credentials at schema-build time from the CredentialFieldMarker registry the #[derive(Credentials)] macro emits per credential-bearing type (AUTHZ-CRED-MACRO-1).

§Field path semantics (Tier B Q-IR-1)

field_path is the JSON-object path to the credential field within the method’s return type. v1 always uses object-field paths (one segment per field name walked); array indices and JSON Pointer syntax are intentionally excluded because credentials always live on object fields in v1, never inside array elements.

Example: for a return type struct LoginResult { session: Credential<String> }, the field path is ["session"]. For a nested case struct LoginResult { auth: AuthBundle } where AuthBundle itself declares a #[plexus::credential(..)] field token: Credential<String>, the field path is ["auth", "token"].

§Variant tagging

variant_tag is Some(tag) when the method’s return type is an enum and the credential lives on a single variant. The tag matches the variant identifier as the macro registry records it (e.g. "Issued" for the LoginEvent::Issued variant). None means the return type is a struct, or the credential appears on every variant of the enum (rare).

§Wire back-compat

Added in AUTHZ-CRED-CORE-3. Pre-existing readers tolerate credentials: [] (the default on MethodSchema when no credentials are declared) and pre-existing IRs that omit the field altogether decode cleanly via #[serde(default)] on the field site.

Fields§

§field_path: Vec<String>

JSON-object path to the credential field within the method’s return type. One segment per field-name walk; pinned to object paths (no array indices, no JSON Pointer) per Tier B Q-IR-1.

§variant_tag: Option<String>

Variant tag when the return type is an enum and the credential lives on a single variant. None for structs.

§metadata: CredentialMetadata

The credential’s metadata (kind, attach site, scheme, scopes, expiry, refresh/revoke hints, issuer, sensitivity). Carried verbatim so consumers embed identical storage-and-attach logic to the runtime.

Implementations§

Source§

impl CredentialFieldDecl

Source

pub fn from_marker( marker: &CredentialFieldMarker, path_prefix: &[&str], issuer: CredentialIssuer, ) -> Self

Construct a CredentialFieldDecl by composing a CredentialFieldMarker from the macro-emitted registry with the runtime-supplied pieces (expires_at known only at mint time; issuer known at schema-build time from the originating method’s (Origin, MethodPath)).

path_prefix is the field-path walk to the marker’s parent type — for a flat struct it is empty; for a nested case where this marker lives inside a field of the method’s return type the prefix is the path to that wrapping field. The marker’s own field and variant are appended.

Trait Implementations§

Source§

impl Clone for CredentialFieldDecl

Source§

fn clone(&self) -> CredentialFieldDecl

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CredentialFieldDecl

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CredentialFieldDecl

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for CredentialFieldDecl

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl PartialEq for CredentialFieldDecl

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for CredentialFieldDecl

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for CredentialFieldDecl

Source§

impl StructuralPartialEq for CredentialFieldDecl

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,