CdcApp

Struct CdcApp 

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

High-level CDC application runner

This struct encapsulates the complete CDC application workflow, providing a clean interface for running CDC replication with proper initialization, shutdown handling, and error management.

Implementations§

Source§

impl CdcApp

Source

pub async fn new(config: CdcAppConfig) -> CdcResult<Self>

Create a new CDC application instance

§Arguments
  • config - The CDC application configuration to use
§Returns

Returns a CdcResult<CdcApp> with the initialized application instance.

§Errors

Returns CdcError if the CDC client cannot be created or initialized.

Source

pub async fn from_config(cdc_config: Config) -> CdcResult<Self>

Create a new CDC application instance with just the CDC config (backwards compatible)

§Arguments
  • cdc_config - The CDC configuration to use
§Returns

Returns a CdcResult<CdcApp> with the initialized application instance.

§Errors

Returns CdcError if the CDC client cannot be created or initialized.

Source

pub async fn run(&mut self, lsn_file_path: Option<&str>) -> CdcResult<()>

Run the CDC application with graceful shutdown handling

This method starts the CDC replication process and handles graceful shutdown when shutdown signals are received. It automatically loads the last LSN from persistence to resume replication from where it left off.

This method now automatically handles metrics server initialization when the metrics feature is enabled, removing the need for feature checking in the main application.

§Arguments
  • lsn_file_path - Optional path to the LSN persistence file. If None, uses the default from environment variables or “./pg2any_last_lsn”
§Returns

Returns CdcResult<()> when the application completes successfully or is gracefully shut down.

§Errors

Returns CdcError if:

  • Replication fails to start or encounters an error
  • Shutdown handling fails
  • Client stop operation fails
  • Metrics server fails to start (when metrics feature is enabled)

Auto Trait Implementations§

§

impl Freeze for CdcApp

§

impl !RefUnwindSafe for CdcApp

§

impl Send for CdcApp

§

impl Sync for CdcApp

§

impl Unpin for CdcApp

§

impl !UnwindSafe for CdcApp

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> 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 = 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