Skip to main content

StreamingConfigBuilder

nautilus_persistence::config

Struct StreamingConfigBuilder 

Source 
pub struct StreamingConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build_inner().

Implementations§

Source§

impl<S: State> StreamingConfigBuilder<S>

Source

pub fn writer_path( self, value: String, ) -> StreamingConfigBuilder<SetWriterPath<S>>
where S::WriterPath: IsUnset,

Required.

Local directory the writer appends Feather files to.

Source

pub fn catalog( self, value: DataCatalogConfig, ) -> StreamingConfigBuilder<SetCatalog<S>>
where S::Catalog: IsUnset,

Optional (Some / Option setters). Catalog that receives promoted data; omit to keep only the Feather files.

Source

pub fn maybe_catalog( self, value: Option<DataCatalogConfig>, ) -> StreamingConfigBuilder<SetCatalog<S>>
where S::Catalog: IsUnset,

Optional (Some / Option setters). Catalog that receives promoted data; omit to keep only the Feather files.

Source

pub fn flush_interval_ms( self, value: u64, ) -> StreamingConfigBuilder<SetFlushIntervalMs<S>>
where S::FlushIntervalMs: IsUnset,

Required.

Flush interval in milliseconds.

Source

pub fn replace_existing( self, value: bool, ) -> StreamingConfigBuilder<SetReplaceExisting<S>>
where S::ReplaceExisting: IsUnset,

Required.

Whether to replace existing files.

Source

pub fn rotation_config( self, value: RotationConfig, ) -> StreamingConfigBuilder<SetRotationConfig<S>>
where S::RotationConfig: IsUnset,

Required.

Rotation configuration.

Source

pub fn promotion_interval_ms( self, value: u64, ) -> StreamingConfigBuilder<SetPromotionIntervalMs<S>>
where S::PromotionIntervalMs: IsUnset,

Optional (Some / Option setters). Interval in milliseconds for promoting sealed files into catalog; omit for no interval.

Source

pub fn maybe_promotion_interval_ms( self, value: Option<u64>, ) -> StreamingConfigBuilder<SetPromotionIntervalMs<S>>
where S::PromotionIntervalMs: IsUnset,

Optional (Some / Option setters). Interval in milliseconds for promoting sealed files into catalog; omit for no interval.

Source

pub fn promote_on_close( self, value: bool, ) -> StreamingConfigBuilder<SetPromoteOnClose<S>>
where S::PromoteOnClose: IsUnset,

Optional (Some / Option setters). Default: default_promote_on_close().

Whether closing the writer promotes remaining files into catalog.

Source

pub fn maybe_promote_on_close( self, value: Option<bool>, ) -> StreamingConfigBuilder<SetPromoteOnClose<S>>
where S::PromoteOnClose: IsUnset,

Optional (Some / Option setters). Default: default_promote_on_close().

Whether closing the writer promotes remaining files into catalog.

Source

pub fn delete_feather_after_promotion( self, value: bool, ) -> StreamingConfigBuilder<SetDeleteFeatherAfterPromotion<S>>
where S::DeleteFeatherAfterPromotion: IsUnset,

Optional (Some / Option setters). Default: false.

Whether Feather files are deleted after a successful promotion.

Source

pub fn maybe_delete_feather_after_promotion( self, value: Option<bool>, ) -> StreamingConfigBuilder<SetDeleteFeatherAfterPromotion<S>>
where S::DeleteFeatherAfterPromotion: IsUnset,

Optional (Some / Option setters). Default: false.

Whether Feather files are deleted after a successful promotion.

Source

pub fn use_ts_event_for_ts_init( self, value: bool, ) -> StreamingConfigBuilder<SetUseTsEventForTsInit<S>>
where S::UseTsEventForTsInit: IsUnset,

Optional (Some / Option setters). Default: false.

Whether promotion replaces ts_init with ts_event.

Source

pub fn maybe_use_ts_event_for_ts_init( self, value: Option<bool>, ) -> StreamingConfigBuilder<SetUseTsEventForTsInit<S>>
where S::UseTsEventForTsInit: IsUnset,

Optional (Some / Option setters). Default: false.

Whether promotion replaces ts_init with ts_event.

Source

pub fn data_types( self, value: Vec<NautilusDataType>, ) -> StreamingConfigBuilder<SetDataTypes<S>>
where S::DataTypes: IsUnset,

Optional (Some / Option setters). Optional data families to write.

Source

pub fn maybe_data_types( self, value: Option<Vec<NautilusDataType>>, ) -> StreamingConfigBuilder<SetDataTypes<S>>
where S::DataTypes: IsUnset,

Optional (Some / Option setters). Optional data families to write.

Source

pub fn record_types( self, value: Vec<NautilusRecordType>, ) -> StreamingConfigBuilder<SetRecordTypes<S>>
where S::RecordTypes: IsUnset,

Optional (Some / Option setters). Optional record families to write.

Source

pub fn maybe_record_types( self, value: Option<Vec<NautilusRecordType>>, ) -> StreamingConfigBuilder<SetRecordTypes<S>>
where S::RecordTypes: IsUnset,

Optional (Some / Option setters). Optional record families to write.

Source

pub fn instrument_types( self, value: Vec<NautilusInstrumentType>, ) -> StreamingConfigBuilder<SetInstrumentTypes<S>>
where S::InstrumentTypes: IsUnset,

Optional (Some / Option setters). Optional instrument families to write.

Source

pub fn maybe_instrument_types( self, value: Option<Vec<NautilusInstrumentType>>, ) -> StreamingConfigBuilder<SetInstrumentTypes<S>>
where S::InstrumentTypes: IsUnset,

Optional (Some / Option setters). Optional instrument families to write.

Source

pub fn record_filters( self, value: Vec<StreamingRecordFilterConfig>, ) -> StreamingConfigBuilder<SetRecordFilters<S>>
where S::RecordFilters: IsUnset,

Optional (Some / Option setters). Optional record family and identifier filters.

Source

pub fn maybe_record_filters( self, value: Option<Vec<StreamingRecordFilterConfig>>, ) -> StreamingConfigBuilder<SetRecordFilters<S>>
where S::RecordFilters: IsUnset,

Optional (Some / Option setters). Optional record family and identifier filters.

Source

pub fn params(self, value: Params) -> StreamingConfigBuilder<SetParams<S>>
where S::Params: IsUnset,

Optional (Some / Option setters). Backend-specific writer parameters.

Source

pub fn maybe_params( self, value: Option<Params>, ) -> StreamingConfigBuilder<SetParams<S>>
where S::Params: IsUnset,

Optional (Some / Option setters). Backend-specific writer parameters.

Source§

impl<S: IsComplete> StreamingConfigBuilder<S>

Source

pub fn build(self) -> ConfigResult<StreamingConfig>

Validates and builds the StreamingConfig.

§Errors

Returns an error if any field fails validation (see StreamingConfig::validate).

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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
§

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

§

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more