Struct Resync 

pub struct Resync { /* private fields */ }

Available on crate feature client only.

Builds the pull that brings a receiver back in sync.

use ocpi_kit::client::Resync;
use ocpi_kit::types::DateTime;

let last_success: DateTime = "2024-03-01T10:00:00Z".parse()?;
let now: DateTime = "2024-03-01T14:00:00Z".parse()?;

let plan = Resync::new().plan(last_success, now);
// The window starts before the last success, so nothing written around the cut is missed.
assert!(plan.query.date_from.unwrap() < last_success);
assert_eq!(plan.query.date_to, Some(now));

Implementations

impl Resync

pub fn new() -> Self

A resync with the recommended defaults.

pub const fn with_overlap(self, overlap: Duration) -> Self

How far back the window reaches beyond the last successful pull.

pub const fn with_poll_interval(self, interval: Duration) -> Self

The routine polling interval.

pub fn with_splay(self, fraction: f32) -> Self

How much of the interval the splay may add or remove, as a fraction. Clamped to 0.0..=1.0.

pub const fn with_page_limit(self, limit: u64) -> Self

Asks for a specific page size.

pub fn plan(&self, last_success: DateTime, now: DateTime) -> ResyncPlan

The query that catches up everything changed since last_success, up to now.

pub fn incremental(&self, last_success: DateTime) -> PageQuery

The query for a routine incremental pull, with no end bound.

An open-ended window keeps picking up objects written while the crawl runs, which is what a steady-state poll wants; use Resync::plan when a closed interval matters.

pub fn splayed_interval(&self, seed: DateTime) -> Duration

The polling interval with splay applied, so a fleet of clients does not synchronise.

The splay is derived from seed rather than from a random number generator, so a given client polls at a stable, uncorrelated offset and the behaviour is reproducible in tests.

Trait Implementations

impl Clone for Resync

fn clone(&self) -> Resync

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Resync

impl Debug for Resync

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

Formats the value using the given formatter.

impl Default for Resync

fn default() -> Self

Returns the “default value” for a type.