summaryrefslogtreecommitdiffstats
path: root/vendor/ct-codecs/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:41 +0000
commit10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87 (patch)
treebdffd5d80c26cf4a7a518281a204be1ace85b4c1 /vendor/ct-codecs/README.md
parentReleasing progress-linux version 1.70.0+dfsg1-9~progress7.99u1. (diff)
downloadrustc-10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87.tar.xz
rustc-10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87.zip
Merging upstream version 1.70.0+dfsg2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/ct-codecs/README.md')
-rw-r--r--vendor/ct-codecs/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/vendor/ct-codecs/README.md b/vendor/ct-codecs/README.md
new file mode 100644
index 000000000..ccfe63588
--- /dev/null
+++ b/vendor/ct-codecs/README.md
@@ -0,0 +1,21 @@
+# CT-Codecs
+
+A reimplementation of the base64 and hexadecimal codecs from libsodium and libhydrogen in Rust.
+
+- Constant-time for a given length, suitable for cryptographic purposes
+- Strict (base64 strings are not malleable)
+- Supports padded and unpadded, original and URL-safe base64 variants
+- Supports characters to be ignored by the decoder
+- Zero dependencies, `no_std` friendly.
+
+## [API documentation](https://docs.rs/ct-codecs)
+
+## Example usage
+
+```rust
+use ct_codecs::{Base64UrlSafe, Decoder, Encoder};
+
+let encoded = Base64UrlSafe::encode_to_string(x)?;
+let decoded = Base64UrlSafe::decode_to_vec(encoded, None)?;
+```
+