mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-03 21:45:51 -04:00
10069fbead
Now that there is some support for [MSC2530](https://github.com/matrix-org/matrix-spec-proposals/pull/2530), I gave adding sending captions a try. ( This is my first time with Rust 😄 ) I tried it on Element X with a hardcoded caption and it seems to work well  (It even got forwarded through mautrix-whatsapp and the caption was visible on the Whatsapp side) --- * ffi: Expose filename and formatted body fields for media captions In relevance to MSC2530 * MSC2530: added the ability to send media with captions Signed-off-by: Marco Antonio Alvarez <surakin@gmail.com> * signoff Signed-off-by: Marco Antonio Alvarez <surakin@gmail.com> * fixing the import messup * fix missing parameters in documentation * fix formatting * move optional parameters to the end * more formatting fixes * more formatting fixes * rename url parameter to filename in send_attachment and helpers * fix send_attachment documentation example * move caption and formatted_caption into attachmentconfig * fix formatting * fix formatting * fix formatting (hopefully the last one) * updated stale comments * simplify attachment message comments --------- Signed-off-by: Marco Antonio Alvarez <surakin@gmail.com> Co-authored-by: SpiritCroc <dev@spiritcroc.de>
matrix-rust-sdk
matrix-rust-sdk is an implementation of a Matrix client-server library in Rust.
Project structure
The rust-sdk consists of multiple crates that can be picked at your convenience:
- matrix-sdk - High level client library, with batteries included, you're most likely interested in this.
- matrix-sdk-base - No (network) IO client state machine that can be used to embed a Matrix client in your project or build a full fledged network enabled client lib on top of it.
- matrix-sdk-crypto - No (network) IO encryption state machine that can be used to add Matrix E2EE support to your client or client library.
Minimum Supported Rust Version (MSRV)
These crates are built with the Rust language version 2021 and require a minimum compiler version of 1.70.
Status
The library is in an alpha state, things that are implemented generally work but the API will change in breaking ways.
If you are interested in using the matrix-sdk now is the time to try it out and provide feedback.
Bindings
Some crates of the matrix-rust-sdk can be embedded inside other
environments, like Swift, Kotlin, JavaScript, Node.js etc. Please,
explore the bindings/ directory to learn more.