Skip to content

sdk: fix with_light_mode docs #2700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025
Merged

sdk: fix with_light_mode docs #2700

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions crates/sdk/src/db_connection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,10 +926,12 @@ but you must call one of them, or else the connection will never progress.
/// Sets whether the "light" mode is used.
///
/// The light mode is meant for clients which are network-bandwidth constrained
/// and results in the following:
/// - Incremental updates will not include information about the reducer that caused them.
/// - The client will not be notified about a reducer the client called
/// without being subscribed to any relevant queries.
/// and results in non-callers receiving only light incremental updates.
/// These updates will not include information about the reducer that caused them,
/// but will contain updates to subscribed-to tables.
/// As a consequence, when light-mode is enabled,
/// non-callers will not receive reducer callbacks,
/// but will receive callbacks for row insertion/deletion/updates.
pub fn with_light_mode(mut self, light: bool) -> Self {
self.params.light = light;
self
Expand Down
Loading