Skip to content

Commit faa2bb5

Browse files
authored
der: note no_alloc in docs (#2207)
It already says "heapless" but this seems to be the way people tend to refer to it these days
1 parent ba4e737 commit faa2bb5

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

der/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ version = "0.8.0-rc.10"
44
description = """
55
Pure Rust embedded-friendly implementation of the Distinguished Encoding Rules
66
(DER) for Abstract Syntax Notation One (ASN.1) as described in ITU X.690 with
7-
full support for heapless no_std targets
7+
full support for heapless `no_std`/`no_alloc` targets
88
"""
99
authors = ["RustCrypto Developers"]
1010
license = "Apache-2.0 OR MIT"
1111
homepage = "https://github.com/RustCrypto/formats/tree/master/der"
1212
repository = "https://github.com/RustCrypto/formats"
1313
categories = ["cryptography", "data-structures", "encoding", "no-std", "parser-implementations"]
14-
keywords = ["asn1", "crypto", "itu", "pkcs"]
14+
keywords = ["asn1", "crypto", "no-alloc", "itu", "pkcs"]
1515
readme = "README.md"
1616
edition = "2024"
1717
rust-version = "1.85"

der/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ for Abstract Syntax Notation One (ASN.1) as described in [ITU X.690].
1414

1515
## About
1616

17-
This crate provides a `no_std`-friendly implementation of a subset of ASN.1 DER
17+
This crate provides a `no_std`/`no_alloc`-friendly implementation of a subset of ASN.1 DER
1818
necessary for decoding/encoding the following cryptography-related formats
1919
implemented as crates maintained by the [RustCrypto] project:
2020

@@ -28,8 +28,8 @@ implemented as crates maintained by the [RustCrypto] project:
2828
- [`x509-cert`]: Public Key Infrastructure Certificate
2929
- [`x509-ocsp`]: Online Certificate Status Protocol
3030

31-
The core implementation avoids any heap usage (with convenience methods
32-
that allocate gated under the off-by-default `alloc` feature).
31+
The core implementation avoids any heap usage (with convenience methods that allocate gated under
32+
the off-by-default `alloc` feature).
3333

3434
The DER decoder in this crate performs checks to ensure that the input document
3535
is in canonical form, and will return errors if non-canonical productions are
@@ -41,8 +41,8 @@ encountered. There is currently no way to disable these checks.
4141
- Performs DER canonicalization checks at decoding time
4242
- `no_std` friendly: supports "heapless" usage
4343
- Optionally supports `alloc` and `std` if desired
44-
- No hard dependencies! Self-contained implementation with optional
45-
integrations with the following crates, all of which are `no_std` friendly:
44+
- No hard dependencies! Self-contained implementation with optional integrations with the following crates, all of
45+
which are `no_std`/`no_alloc` friendly:
4646
- `const-oid`: const-friendly OID implementation
4747
- `pem-rfc7468`: PKCS/PKIX-flavored PEM library with constant-time decoder/encoders
4848
- `time` crate: date/time library

0 commit comments

Comments
 (0)