pub struct SpacetimeDbClient<Connection>{ /* private fields */ }Expand description
Shared lifecycle owner for generated app-specific SpacetimeDB connections.
Apps still own their generated DbConnection type, table accessors, reducers,
subscriptions, and row projection logic. This shared owner centralizes retry,
reconnect, worker ownership, optional-read degradation, serial read-projection
throttling, and panic-tolerant cleanup.
Implementations§
Source§impl<Connection> SpacetimeDbClient<Connection>
impl<Connection> SpacetimeDbClient<Connection>
Sourcepub fn connect<Build>(
target: ConnectionTarget,
connection_label: impl Into<String>,
build: Build,
) -> Result<Self, String>where
Build: FnMut(&ConnectionTarget) -> Result<(Connection, JoinHandle<()>), String> + Send + 'static,
pub fn connect<Build>(
target: ConnectionTarget,
connection_label: impl Into<String>,
build: Build,
) -> Result<Self, String>where
Build: FnMut(&ConnectionTarget) -> Result<(Connection, JoinHandle<()>), String> + Send + 'static,
Connects a required app-owned client using the shared retry and cleanup policy.
Sourcepub fn connect_optional_read<Build>(
target: ConnectionTarget,
connection_label: impl Into<String>,
build: Build,
) -> Result<Self, String>where
Build: FnMut(&ConnectionTarget) -> Result<(Connection, JoinHandle<()>), String> + Send + 'static,
pub fn connect_optional_read<Build>(
target: ConnectionTarget,
connection_label: impl Into<String>,
build: Build,
) -> Result<Self, String>where
Build: FnMut(&ConnectionTarget) -> Result<(Connection, JoinHandle<()>), String> + Send + 'static,
Connects an optional read projection unless its shared circuit breaker is degraded.
Sourcepub fn connect_reconnecting<Build>(
target: ConnectionTarget,
connection_label: impl Into<String>,
build: Build,
) -> Result<Self, String>where
Build: Fn(&ConnectionTarget, SpacetimeDbConnectionStatus) -> Result<ManagedSpacetimeDbConnection<Connection>, String> + Send + Sync + 'static,
pub fn connect_reconnecting<Build>(
target: ConnectionTarget,
connection_label: impl Into<String>,
build: Build,
) -> Result<Self, String>where
Build: Fn(&ConnectionTarget, SpacetimeDbConnectionStatus) -> Result<ManagedSpacetimeDbConnection<Connection>, String> + Send + Sync + 'static,
Connects a required app-owned client and restores it after disconnection.
Sourcepub fn connection(&self) -> &Connection
pub fn connection(&self) -> &Connection
Returns a fixed generated connection owned by this lifecycle guard.
Reconnecting clients use reconnecting_connection so access remains locked
while a disconnected connection is replaced.
Sourcepub fn reconnecting_connection(
&self,
) -> Result<SpacetimeDbConnectionGuard<'_, Connection>, String>
pub fn reconnecting_connection( &self, ) -> Result<SpacetimeDbConnectionGuard<'_, Connection>, String>
Returns the current reconnecting connection, rebuilding it when required.
Sourcepub fn is_connected(&self) -> bool
pub fn is_connected(&self) -> bool
Returns the last connection status reported by a reconnecting client.
Sourcepub fn invalidate_reconnecting_connection(&self) -> Result<(), String>
pub fn invalidate_reconnecting_connection(&self) -> Result<(), String>
Invalidates the current reconnecting connection after an incomplete connection-scoped operation.
The next reconnecting_connection access rebuilds the app-owned
connection through its registered builder.
Auto Trait Implementations§
impl<Connection> !Freeze for SpacetimeDbClient<Connection>
impl<Connection> !RefUnwindSafe for SpacetimeDbClient<Connection>
impl<Connection> !UnwindSafe for SpacetimeDbClient<Connection>
impl<Connection> Send for SpacetimeDbClient<Connection>where
SpacetimeDbClientConnection<Connection>: Send,
Option<Arc<dyn Fn(&ConnectionTarget, SpacetimeDbConnectionStatus) -> Result<ManagedSpacetimeDbConnection<Connection>, String> + Send + Sync>>: Send,
impl<Connection> Sync for SpacetimeDbClient<Connection>where
SpacetimeDbClientConnection<Connection>: Sync,
Option<Arc<dyn Fn(&ConnectionTarget, SpacetimeDbConnectionStatus) -> Result<ManagedSpacetimeDbConnection<Connection>, String> + Send + Sync>>: Sync,
impl<Connection> Unpin for SpacetimeDbClient<Connection>where
SpacetimeDbClientConnection<Connection>: Unpin,
Option<Arc<dyn Fn(&ConnectionTarget, SpacetimeDbConnectionStatus) -> Result<ManagedSpacetimeDbConnection<Connection>, String> + Send + Sync>>: Unpin,
impl<Connection> UnsafeUnpin for SpacetimeDbClient<Connection>where
SpacetimeDbClientConnection<Connection>: UnsafeUnpin,
Option<Arc<dyn Fn(&ConnectionTarget, SpacetimeDbConnectionStatus) -> Result<ManagedSpacetimeDbConnection<Connection>, String> + Send + Sync>>: UnsafeUnpin,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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