mongodb / mongo-rust-driver

The official MongoDB Rust Driver
https://www.mongodb.com/docs/drivers/rust/current/
Apache License 2.0
1.44k stars 164 forks source link

RUST-1795 Add an [in]stability note for mongocrypt #1195

Closed abr-egn closed 2 months ago

abr-egn commented 2 months ago

RUST-1795

This adds a note that the pre-1.0 mongocrypt re-export shouldn't be considered to be stable.

I did do a once-over to see if there are any areas of particularly high risk and the short answer is it's really hard to tell with an API that wraps C ☹️ Anything that currently uses constant string values in C to represent an enum (Algorithm for example) could change in the C API to have semi-structured data the way KMS providers did. There are also functions in C that accept a binary buffer where the contents expected could change arbitrarily.