Skip to main content

Module transform

Module transform 

Source
Expand description

Record transformation pipeline.

§Built-in transforms (optional Cargo features)

VariantFeature flagDefault
RecordTransform::Flattentransform-flattenenabled
RecordTransform::RenameKeystransform-rename-keysenabled
RecordTransform::KeysCasetransform-keys-caseenabled
RecordTransform::Selecttransform-selectoff
RecordTransform::Droptransform-dropoff
RecordTransform::Settransform-setoff
RecordTransform::RenameFieldtransform-rename-fieldoff
RecordTransform::Casttransform-castoff
RecordTransform::Redacttransform-redactoff
RecordTransform::ValueCasetransform-value-caseoff
RecordTransform::SpellSymbolstransform-spell-symbolsoff

The transforms aggregate feature pulls in every variant above.

Disable a transform (and its dependencies) by opting out of its feature:

[dependencies]
faucet-stream = { version = "*", default-features = false,
                  features = ["transform-flatten"] }

§Stage-level transforms (filter / explode)

filter and explode are not RecordTransform variants — they live as crate::stage::TransformStage::Filter / TransformStage::Explode because they may emit 0 or N records per input. Their feature flags are transform-filter and transform-explode. See the stage module for details.

§Custom transforms

RecordTransform::Custom is always available regardless of features. Pass any closure or function pointer via RecordTransform::custom.

Enums§

CastOnErrortransform-cast
Failure policy for RecordTransform::Cast. Default: Error.
CastTypetransform-cast
Target type for RecordTransform::Cast.
CompiledTransform
Pre-compiled form of a RecordTransform.
KeyCaseModetransform-keys-case
Output convention for RecordTransform::KeysCase.
RecordTransform
A transformation applied to every record fetched by a source (e.g. the REST source’s RestStream).
ValueCaseModetransform-value-case
String-value casing mode for RecordTransform::ValueCase.

Functions§

apply_all
Apply a slice of pre-compiled transforms to a record, in order.
compile
Compile a RecordTransform into its CompiledTransform form.
default_symbol_maptransform-spell-symbols
Built-in symbol → word map used by RecordTransform::SpellSymbols.