Skip to main content

SyncConfig

Struct SyncConfig 

Source
pub struct SyncConfig {
    pub agent_id: String,
    pub tenant_id: String,
    pub store_id: String,
    pub buffer_capacity: usize,
    pub batch_size: usize,
    pub outbox_capacity: usize,
    pub outbox_path: Option<String>,
}
Expand description

Configuration for the sync engine.

Maps to the JS SyncConfig (agent_id, tenant_id, store_id) plus tuning knobs for buffer capacity and batch sizes.

§Examples

use stateset_sync::SyncConfig;

let config = SyncConfig::new("agent-1", "tenant-1", "store-1");
assert_eq!(config.agent_id, "agent-1");
assert_eq!(config.buffer_capacity, 1000);

Fields§

§agent_id: String

Unique identifier for this agent.

§tenant_id: String

Tenant identifier for multi-tenancy.

§store_id: String

Store identifier within the tenant.

§buffer_capacity: usize

Maximum number of events the in-memory buffer can hold.

§batch_size: usize

Maximum events per push/pull batch.

§outbox_capacity: usize

Maximum pending local events in the outbox.

§outbox_path: Option<String>

Optional durable outbox snapshot path.

Implementations§

Source§

impl SyncConfig

Source

pub fn new( agent_id: impl Into<String>, tenant_id: impl Into<String>, store_id: impl Into<String>, ) -> Self

Create a new SyncConfig with sensible defaults.

Source

pub const fn with_buffer_capacity(self, capacity: usize) -> Self

Set the buffer capacity.

Source

pub const fn with_batch_size(self, batch_size: usize) -> Self

Set the batch size.

Source

pub const fn with_outbox_capacity(self, capacity: usize) -> Self

Set the outbox capacity.

Source

pub fn with_outbox_path(self, path: impl Into<String>) -> Self

Set the durable outbox path.

Source

pub fn resolved_buffer_capacity(&self) -> usize

Resolve a valid buffer capacity.

Source

pub fn resolved_batch_size(&self) -> usize

Resolve a valid batch size.

Source

pub fn resolved_outbox_capacity(&self) -> usize

Resolve a valid outbox capacity.

Source

pub fn validate(&self) -> Result<(), SyncError>

Validate the configuration.

§Errors

Returns crate::SyncError::InvalidConfig when required fields are invalid.

Trait Implementations§

Source§

impl Clone for SyncConfig

Source§

fn clone(&self) -> SyncConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SyncConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SyncConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SyncConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,