Skip to main content

SyncularConfig

Struct SyncularConfig 

Source
pub struct SyncularConfig {
    pub base_url: Option<String>,
    pub ws_url: Option<String>,
    pub headers: Vec<(String, String)>,
    pub request_timeout_ms: Option<u64>,
    pub round_deadline_ms: Option<u64>,
    pub max_request_bytes: Option<u64>,
    pub max_response_bytes: Option<u64>,
    pub redirects: Option<String>,
    pub db_path: Option<String>,
    pub database_dir: Option<String>,
    pub auto_sync: bool,
    pub authority_columns: BTreeMap<String, Vec<String>>,
}
Expand description

Plugin configuration. Passed to init; every field is optional except a caller almost always wants a base_url (for real network sync) and a database_dir or db_path (for persistence — defaults to an in-memory core if both are absent).

Fields§

§base_url: Option<String>

Server base URL for the native HTTP+WS transport (needs the native-transport feature). Absent → client-local only.

§ws_url: Option<String>

Optional realtime WS URL; derived from base_url when absent.

§headers: Vec<(String, String)>

Extra request headers (auth, actor/project ids) as (name, value).

§request_timeout_ms: Option<u64>

Per-request network deadline in milliseconds. None (the default) leaves requests unbounded, matching the reference HTTP binding.

§round_deadline_ms: Option<u64>

One monotonic deadline for a whole sync round (uploads, continuations, main request, and every segment fetch) in milliseconds. None (the default) leaves the round unbounded.

§max_request_bytes: Option<u64>

Largest request body the transport will send, in bytes. None (the default) is unbounded.

§max_response_bytes: Option<u64>

Largest decoded (post-decompression) response body, in bytes. None (the default) is unbounded.

§redirects: Option<String>

Redirect handling: "deny" (the default) refuses every redirect so configured credentials, URL userinfo, and signed capabilities never replay to another origin; "follow" follows a redirect only for a request with none of those, and still refuses a credential-bearing request.

§db_path: Option<String>

On-disk SQLite path a create opens when it names no database. Absent → in-memory (nothing survives a restart). Apps usually set this to a file under the app-data dir; see init.

§database_dir: Option<String>

Directory of the named databases. A create that carries database (for example one replica per signed-in actor) opens <database_dir>/<database>.db; the plugin creates the directory. The webview names a database and never supplies a path.

§auto_sync: bool

Run the background host loop (§8.4). Default true.

§authority_columns: BTreeMap<String, Vec<String>>

Native app-approved table/column ceiling. Webview create selects scopes and a subset; raw IPC cannot expand this policy.

Trait Implementations§

Source§

impl Clone for SyncularConfig

Source§

fn clone(&self) -> Self

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 Debug for SyncularConfig

Source§

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

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

impl Default for SyncularConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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 = !

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

impl<T> UserEvent for T
where T: Debug + Clone + Send + 'static,