Skip to main content

SourceMappingEngine

Struct SourceMappingEngine 

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

Source mapping engine that transforms payloads into graph change events.

Uses Handlebars templates to extract element IDs, labels, properties, and operations from arbitrary JSON contexts.

The context is a serde_json::Value that each source builds with its own variables. For example:

  • HTTP source: { "payload": ..., "headers": ..., "route": ..., "query": ... }
  • Kafka source: { "payload": ..., "key": ..., "topic": ..., "partition": ..., "offset": ... }

Implementations§

Source§

impl SourceMappingEngine

Source

pub fn new() -> Self

Create a new mapping engine with custom helpers registered

Source

pub fn render_string( &self, template: &str, context: &JsonValue, ) -> Result<String>

Render a template string with the given context

Source

pub fn render_value( &self, template: &str, context: &JsonValue, ) -> Result<JsonValue>

Render a template and preserve the JSON value type

If the template is a simple variable reference like {{payload.field}}, this returns the original JSON value. Otherwise, it returns the rendered string.

Source

pub fn process_mapping( &self, mapping: &SourceMapping, context: &JsonValue, source_id: &str, ) -> Result<SourceChange>

Process a source mapping and create a SourceChange.

The context should be a JSON object containing all variables available to templates (e.g., payload, key, topic, headers, etc.).

Source

pub fn condition_matches( &self, condition: &MappingCondition, context: &JsonValue, headers: Option<&HashMap<String, String>>, ) -> bool

Check if a mapping condition matches the given context.

The headers parameter is optional and only used for header-based conditions.

Source

pub fn find_matching_mapping<'a>( &self, mappings: &'a [SourceMapping], context: &JsonValue, headers: Option<&HashMap<String, String>>, ) -> Option<&'a SourceMapping>

Find the first matching mapping from a list based on conditions.

Returns None if no mapping matches.

Trait Implementations§

Source§

impl Default for SourceMappingEngine

Source§

fn default() -> Self

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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