Skip to content

Commit c6352e9

Browse files
committed
doc(ffi): Update CHANGELOG.md and README.md.
1 parent b5a0fed commit c6352e9

File tree

2 files changed

+41
-10
lines changed

2 files changed

+41
-10
lines changed

bindings/matrix-sdk-ffi/CHANGELOG.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,36 @@ All notable changes to this project will be documented in this file.
66

77
## [Unreleased] - ReleaseDate
88

9-
### Breaking changes:
9+
### Breaking changes
10+
11+
- Add the `sqlite` feature, along with the `indexeddb` feature, to enable
12+
either the SQLite or IndexedDB session store. The `session_paths`,
13+
`session_passphrase`, `session_pool_max_size`, `session_cache_size` and
14+
`session_journal_size_limit` methods on `ClientBuilder` have been removed.
15+
New methods are added: `ClientBuilder::session_store_in_memory` if one wants
16+
non-persistent session storage, `ClientBuilder::session_store_with_sqlite` to
17+
configure and to use SQLite as the session store (if the `sqlite` feature is
18+
enabled), and `ClientBuilder::session_store_with_indexeddb` to configure and
19+
to use IndexedDB as the session store (if the `indexeddb` feature is enabled).
20+
([#5811](https://github.com/matrix-org/matrix-rust-sdk/pull/5811))
21+
22+
The code:
23+
24+
```rust
25+
client_builder
26+
.session_paths("data_path", "cache_path")
27+
.passphrase("foobar")
28+
```
29+
30+
now becomes:
31+
32+
```rust
33+
client_builder
34+
.session_store_with_sqlite(
35+
SqliteSessionStoreBuilder::new("data_path", "cache_path")
36+
.passphrase("foobar")
37+
)
38+
```
1039

1140
- The `waveform` parameter in `Timeline::send_voice_message` format changed to a list of `f32`
1241
between 0 and 1.
@@ -32,7 +61,7 @@ All notable changes to this project will be documented in this file.
3261
- Add `Client::subscribe_to_send_queue_updates` to observe global send queue updates.
3362
([#5784](https://github.com/matrix-org/matrix-rust-sdk/pull/5784))
3463

35-
### Features:
64+
### Features
3665

3766
- Add `Room::mark_as_fully_read_unchecked` so clients can mark a room as read without needing a `Timeline` instance. Note this method is not recommended as it can potentially cause incorrect read receipts, but it can needed in certain cases.
3867
- Add `Timeline::latest_event_id` to be able to fetch the event id of the latest event of the timeline.

bindings/matrix-sdk-ffi/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,33 @@
33
This uses [`uniffi`](https://mozilla.github.io/uniffi-rs/Overview.html) to build the matrix bindings for native support and wasm-bindgen for web-browser assembly support. Please refer to the specific section to figure out how to build and use the bindings for your platform.
44

55
## Features
6+
67
Given the number of platforms targeted, we have broken out a number of features
78

8-
### Platform specific
9+
### Platform specific
10+
911
- `rustls-tls`: Use Rustls as the TLS implementation, necessary on Android platforms.
1012
- `native-tls`: Use the TLS implementation provided by the host system, necessary on iOS and Wasm platforms.
1113

1214
### Functionality
15+
1316
- `sentry`: Enable error monitoring using Sentry, not supports on Wasm platforms.
14-
- `bundled-sqlite`: Use an embedded version of sqlite instead of the system provided one.
17+
- `sqlite`: Use SQLite for the session storage.
18+
- `bundled-sqlite`: Use an embedded version of SQLite instead of the system provided one.
19+
- `indexeddb`: Use IndexedDB for the session storage.
1520

1621
### Unstable specs
22+
1723
- `unstable-msc4274`: Adds support for gallery message types, which contain multiple media elements.
1824

1925
## Platforms
2026

21-
Each supported target should use features to select the relevant TLS system. Here are some suggested feature flags for the major platforms:
27+
Each supported target should use features to select the relevant TLS system. Here are some suggested feature flags for the major platforms:
2228

2329
- Android: `"bundled-sqlite,unstable-msc4274,rustls-tls,sentry"`
2430
- iOS: `"bundled-sqlite,unstable-msc4274,native-tls,sentry"`
25-
- Javascript/Wasm: `"unstable-msc4274,native-tls"`
31+
- JavaScript/Wasm: `"indexeddb,unstable-msc4274,native-tls"`
2632

2733
### Swift/iOS sync
2834

29-
30-
31-
### Swift/iOS async
32-
3335
TBD

0 commit comments

Comments
 (0)