pub struct NormalizationOptions { /* private fields */ }Expand description
Options for normalizing and lowering a TypedStatement to IR.
Configure the normalization/lowering process with custom providers, registries,
field names, and skip flags.
Use normalize_with() to create an instance with defaults.
Implementations§
Source§impl NormalizationOptions
impl NormalizationOptions
Sourcepub fn with_registry(self, registry: Arc<FunctionRegistry>) -> Self
pub fn with_registry(self, registry: Arc<FunctionRegistry>) -> Self
Set a custom function registry.
Sourcepub fn with_provider(self, provider: Arc<dyn EnvironmentProvider>) -> Self
pub fn with_provider(self, provider: Arc<dyn EnvironmentProvider>) -> Self
Set a custom environment provider for table schema lookups.
Sourcepub fn with_timestamp_field(self, field: impl Into<Identifier>) -> Self
pub fn with_timestamp_field(self, field: impl Into<Identifier>) -> Self
Set the timestamp field used by WITHIN normalization.
Defaults to “timestamp”.
Sourcepub fn with_message_field(self, field: impl Into<Identifier>) -> Self
pub fn with_message_field(self, field: impl Into<Identifier>) -> Self
Set the message field used by PARSE when no source is specified.
Defaults to “event.original”.
Sourcepub fn with_lower_filter(self) -> Self
pub fn with_lower_filter(self) -> Self
Enable filter() lowering for backends that don’t have a native array filter function.
When enabled, filter(arr, x -> pred) is lowered to
flatten(transform(arr, x -> if(pred, [x], cast([] AS array(T))))).
The result still uses transform() with a lambda, so with_lower_transform()
should also be set if the backend doesn’t support lambdas.
Defaults to false (filter() is passed through for backends like Trino that support it).
Sourcepub fn with_lower_transform(self) -> Self
pub fn with_lower_transform(self) -> Self
Enable transform() lowering for backends that don’t support lambdas.
When enabled, transform(arr, x -> body) is lowered to an EXPLODE + AGG pattern.
This is needed for DataFusion which doesn’t support lambda expressions.
Defaults to false (transform() is passed through for backends like Trino that support it).
Sourcepub fn skip_statement_passes(self) -> Self
pub fn skip_statement_passes(self) -> Self
Skip statement-level normalization passes (lower_match, nest_from_aliases, etc.).
Sourcepub fn skip_pipeline_passes(self) -> Self
pub fn skip_pipeline_passes(self) -> Self
Skip all pipeline-level normalization passes (implies skip_projection_fusion).
Sourcepub fn skip_projection_fusion(self) -> Self
pub fn skip_projection_fusion(self) -> Self
Skip just the fuse_projections pass.
Sourcepub fn normalize(
self,
statement: Arc<TypedStatement>,
) -> Result<Arc<TypedStatement>, ContextualTranslationErrors>
pub fn normalize( self, statement: Arc<TypedStatement>, ) -> Result<Arc<TypedStatement>, ContextualTranslationErrors>
Run normalization passes only (without converting to IR).
Returns the normalized TypedStatement, suitable for printing via Display.
Sourcepub fn lower(
self,
statement: Arc<TypedStatement>,
) -> Result<IRStatement, ContextualTranslationErrors>
pub fn lower( self, statement: Arc<TypedStatement>, ) -> Result<IRStatement, ContextualTranslationErrors>
Lower a TypedStatement to IR.
Runs all normalization passes and converts to IR. Returns the first error encountered, if any.
Trait Implementations§
Source§impl Clone for NormalizationOptions
impl Clone for NormalizationOptions
Source§fn clone(&self) -> NormalizationOptions
fn clone(&self) -> NormalizationOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for NormalizationOptions
impl !RefUnwindSafe for NormalizationOptions
impl Send for NormalizationOptions
impl Sync for NormalizationOptions
impl Unpin for NormalizationOptions
impl UnsafeUnpin for NormalizationOptions
impl !UnwindSafe for NormalizationOptions
Blanket Implementations§
Source§impl<T> AnyExt for T
impl<T> AnyExt for T
Source§fn downcast_ref<T>(this: &Self) -> Option<&T>where
T: Any,
fn downcast_ref<T>(this: &Self) -> Option<&T>where
T: Any,
T behind referenceSource§fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>where
T: Any,
fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>where
T: Any,
T behind mutable referenceSource§fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>where
T: Any,
fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>where
T: Any,
T behind Rc pointerSource§fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>where
T: Any,
fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>where
T: Any,
T behind Arc pointerSource§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, X> CoerceTo<T> for Xwhere
T: CoerceFrom<X> + ?Sized,
impl<T, X> CoerceTo<T> for Xwhere
T: CoerceFrom<X> + ?Sized,
fn coerce_rc_to(self: Rc<X>) -> Rc<T>
fn coerce_box_to(self: Box<X>) -> Box<T>
fn coerce_ref_to(&self) -> &T
fn coerce_mut_to(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);