Skip to main content

RouteIdentityStep

Struct RouteIdentityStep 

Source
pub struct RouteIdentityStep {
    pub name: String,
    pub config_override: Option<Value>,
    pub on_error: Option<String>,
    pub extra: HashMap<String, Value>,
}
Expand description

One step in the identity-phase pipeline. Points at a plugin registered under the identity.resolve hook, optionally with a per-call config override and an on_error policy that controls what happens when the step fails.

§Cumulative stacking

At runtime, every step in the block runs (subject to its own on_error). Each step’s resolved IdentityPayload accumulates — handlers contribute orthogonal slots (JWT → subject; SPIFFE → caller_workload; agent resolver → agent) so they compose without collision in the common case.

§On-error semantics

  • None or Some("continue") — soft failure: the step’s contribution is dropped, the next step runs, and any missing extensions get caught later by require(authenticated) / require(workload.*) in downstream policy.
  • Some("deny") — hard requirement: a failure halts the request with the plugin’s violation code.

Unknown strings parse as best-effort; future slices may introduce typed enums.

§Per-step config override

config_override reuses the existing per-call override pathway. When present, the framework’s create_override_instance builds a new plugin instance with the merged config and dispatches into it for this route.

Fields§

§name: String

Plugin name — must match an entry in the top-level plugins: block that registers under identity.resolve.

§config_override: Option<Value>

Optional config override applied for this step only. None means “use the plugin’s configured defaults from the plugins: declaration.” Stored as serde_json::Value to match the existing create_override_instance interface.

§on_error: Option<String>

Per-step failure handling. See type-level docs.

§extra: HashMap<String, Value>

Catch-all for any other fields a future schema version adds (timeout, priority, condition, …) — preserved so the parser doesn’t reject configs targeting newer runtimes.

Implementations§

Source§

impl RouteIdentityStep

Source

pub fn bare(name: impl Into<String>) -> Self

Convenience for tests / programmatic construction: build a bare step that just names a plugin with no overrides.

Trait Implementations§

Source§

impl Clone for RouteIdentityStep

Source§

fn clone(&self) -> RouteIdentityStep

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 RouteIdentityStep

Source§

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

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

impl Default for RouteIdentityStep

Source§

fn default() -> RouteIdentityStep

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for RouteIdentityStep

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 Serialize for RouteIdentityStep

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

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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<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