Skip to main content

MessageTransformer

Struct MessageTransformer 

Source
pub struct MessageTransformer { /* private fields */ }
Expand description

Registry of named transformation pipelines.

§Example

use oxirs_stream::message_transformer::*;
use std::collections::HashMap;

let mut transformer = MessageTransformer::new();
let pipeline = TransformPipeline::new(
    MessageFormat::Json,
    MessageFormat::Avro,
    vec![FieldMapping::with_transform("name", "NAME", TransformFn::ToUpper)],
);
transformer.add_pipeline("upper", pipeline);

let mut fields = HashMap::new();
fields.insert("name".to_string(), "alice".to_string());
let payload = MessagePayload::new(fields, MessageFormat::Json);
let result = transformer.transform("upper", payload)?;
assert_eq!(result.fields["NAME"], "ALICE");

Implementations§

Source§

impl MessageTransformer

Source

pub fn new() -> Self

Create an empty transformer.

Source

pub fn add_pipeline(&mut self, name: &str, pipeline: TransformPipeline)

Register a named pipeline. Overwrites any existing pipeline with the same name.

Source

pub fn transform( &self, pipeline_name: &str, payload: MessagePayload, ) -> Result<MessagePayload, TransformError>

Apply the named pipeline to payload.

Each FieldMapping in the pipeline is applied in order:

  1. The value of source_field is read from the payload.
  2. The optional TransformFn is applied.
  3. The result is stored under target_field in the output payload.

Fields present in the payload but not mentioned by any mapping are dropped.

Source

pub fn chain_pipelines( &self, names: &[&str], payload: MessagePayload, ) -> Result<MessagePayload, TransformError>

Apply a sequence of pipelines in order.

The output of each pipeline is fed as the input to the next. The format of the intermediate payloads is updated by each pipeline.

Source

pub fn list_pipelines(&self) -> Vec<&str>

Return the names of all registered pipelines (order unspecified).

Source

pub fn pipeline_count(&self) -> usize

Return the number of registered pipelines.

Source

pub fn has_pipeline(&self, name: &str) -> bool

Check whether a pipeline with the given name exists.

Source

pub fn remove_pipeline(&mut self, name: &str) -> bool

Remove a pipeline by name. Returns true if it was present.

Trait Implementations§

Source§

impl Debug for MessageTransformer

Source§

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

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

impl Default for MessageTransformer

Source§

fn default() -> MessageTransformer

Returns the “default value” for a type. 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> ErasedDestructor for T
where T: 'static,