Skip to main content

TransformMiddleware

Struct TransformMiddleware 

Source
pub struct TransformMiddleware {
    pub mapping: HashMap<String, MappingRule>,
    pub schema: Option<Value>,
    pub schema_file: Option<String>,
    pub coerce: bool,
    pub apply_defaults: bool,
    pub on_error: TransformErrorPolicy,
}
Expand description

JSON transform middleware configuration.

Reshapes JSON payloads declaratively, in two stages over a single parse: field mapping (rename/move/nest), then schema (type coercion, defaults, validation). Either stage may be omitted; with neither configured the message passes through untouched and is never parsed.

On an output endpoint a rejected message becomes a non-retryable failure, so a dlq middleware listed after this one captures it (publisher middlewares are wrapped in list order, so the last entry is the outermost layer). On an input endpoint a rejected message is dropped from the batch and acknowledged, which is how invalid input is kept out of the route.

Fields§

§mapping: HashMap<String, MappingRule>

Output field name -> source path (e.g. firstName: "$.first_name"). Dots nest the output.

§schema: Option<Value>

Inline JSON Schema subset (type, properties, required, default, items, nullable, enum).

§schema_file: Option<String>

Path to a JSON Schema file. Read once at startup; never re-read per message.

§coerce: bool

Coerce safely convertible types (e.g. "42" -> 42) instead of rejecting. Defaults to true.

§apply_defaults: bool

Insert default values from the schema for missing fields. Defaults to true.

§on_error: TransformErrorPolicy

What to do with a message that fails to transform. Defaults to reject.

Trait Implementations§

Source§

impl Clone for TransformMiddleware

Source§

fn clone(&self) -> TransformMiddleware

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 TransformMiddleware

Source§

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

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

impl Default for TransformMiddleware

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for TransformMiddleware

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 TransformMiddleware

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