xref: /aosp_15_r20/external/boringssl/src/rust/bssl-crypto/README.md (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1*8fb009dcSAndroid Build Coastguard Workerbssl-crypto
2*8fb009dcSAndroid Build Coastguard Worker============
3*8fb009dcSAndroid Build Coastguard Worker
4*8fb009dcSAndroid Build Coastguard WorkerRust bindings to BoringSSL which wrap bssl-sys. Before using this crate, first [set up `bssl-sys`](../bssl-sys/README.md).
5*8fb009dcSAndroid Build Coastguard Worker
6*8fb009dcSAndroid Build Coastguard WorkerThen to run all tests:
7*8fb009dcSAndroid Build Coastguard Worker```
8*8fb009dcSAndroid Build Coastguard Workercd rust/bssl-crypto && cargo clippy && cargo deny check && cargo test
9*8fb009dcSAndroid Build Coastguard Worker```
10*8fb009dcSAndroid Build Coastguard Worker
11*8fb009dcSAndroid Build Coastguard WorkerUnlike BoringSSL itself, this crate does not attempt to handle allocation failures. If an allocation fails, functions in this crate will panic.
12*8fb009dcSAndroid Build Coastguard Worker
13*8fb009dcSAndroid Build Coastguard WorkerWARNING - This crate is experimental and does *NOT* have a stable API. We expect to iterate on the API as it develops. If you use this crate you must be prepared to adapt your code to future changes as they occur. Additionally, this crate must be updated atomically with BoringSSL. The crate, internally, may depend on implementation details of the library.
14*8fb009dcSAndroid Build Coastguard Worker
15