Skip to main content

ReplicationParams

Struct ReplicationParams 

Source
pub struct ReplicationParams<'a> {
    pub connection_url: &'a str,
    pub slot_name: &'a str,
    pub publication_name: &'a str,
    pub proto_version: u32,
    pub create_slot_if_missing: bool,
    pub start_lsn: Option<u64>,
    pub status_update_interval: Duration,
    pub tcp_keepalive: Duration,
    pub slot_type: SlotType,
    pub tls: &'a CdcTls,
}
Expand description

All parameters required to establish a logical replication connection.

This struct is accepted by every function in this module.

Fields§

§connection_url: &'a str

postgres://user:pass@host:port/db style URL.

§slot_name: &'a str

Name of the replication slot (must already exist, or create_slot_if_missing = true).

§publication_name: &'a str

Publication name — must already exist on the server.

§proto_version: u32

pgoutput protocol version. Only 1 is currently supported.

§create_slot_if_missing: bool

Create the slot if it does not already exist.

§start_lsn: Option<u64>

Optional LSN to resume from. None means “start from the slot’s confirmed_flush_lsn”.

§status_update_interval: Duration

Protocol-level Standby Status Update cadence — must be shorter than the server’s wal_sender_timeout.

§tcp_keepalive: Duration

TCP-level keepalive interval. Larger than status_update_interval in normal operation.

§slot_type: SlotType

Whether a newly-created slot is permanent or temporary.

§tls: &'a CdcTls

TLS settings for the replication connection.

Trait Implementations§

Source§

impl<'a> Clone for ReplicationParams<'a>

Source§

fn clone(&self) -> ReplicationParams<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for ReplicationParams<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ReplicationParams<'a>

§

impl<'a> RefUnwindSafe for ReplicationParams<'a>

§

impl<'a> Send for ReplicationParams<'a>

§

impl<'a> Sync for ReplicationParams<'a>

§

impl<'a> Unpin for ReplicationParams<'a>

§

impl<'a> UnsafeUnpin for ReplicationParams<'a>

§

impl<'a> UnwindSafe for ReplicationParams<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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