Skip to content

der: remove lifetime from OctetStringRef - #1998

Merged
tarcieri merged 1 commit into
masterfrom
der/remove-octet-string-ref-lifetime
Sep 15, 2025
Merged

der: remove lifetime from OctetStringRef#1998
tarcieri merged 1 commit into
masterfrom
der/remove-octet-string-ref-lifetime

Conversation

@tarcieri

@tarcieritarcieri commented Aug 18, 2025

Copy link
Copy Markdown
Member

Following the pattern of #1921, removes the lifetime from the struct, instead changing OctetStringRef to a proper reference type to be used as &OctetStringRef.

This makes it possible to impl Borrow<OctetStringRef> for OctetString and impl ToOwned for OctetStringRef, so they can work with Cow.

cc @dishmaker

@tarcieri
tarcieri requested a review from balooAugust 18, 2025 14:22
@tarcieri

tarcieri commented Aug 18, 2025

Copy link
Copy Markdown
MemberAuthor

Custom derive needs to be updated to be aware that certain types are reference types and need to be used as e.g. <&OctetStringRef>::decode instead of OctetStringRef::decode

@tarcieri
tarcieriforce-pushed the der/remove-octet-string-ref-lifetime branch from 8cee1e0 to 2359ca5CompareAugust 18, 2025 14:38
tarcieri
tarcieri commented Aug 18, 2025
View reviewed changes
Comment threadder/src/asn1/octet_string.rs
dishmaker
dishmaker reviewed Aug 19, 2025
View reviewed changes
Comment threadder/src/asn1/octet_string.rs
@tarcieri
tarcieriforce-pushed the der/remove-octet-string-ref-lifetime branch 4 times, most recently from 54b1fbb to 2a06ecaCompareSeptember 15, 2025 19:01
@tarcieri

tarcieri commented Sep 15, 2025

Copy link
Copy Markdown
MemberAuthor

Well, with a few hacks this is green. I think the hacks might be OK to merge with, but we'd ideally want to get them removed before a final release.

@tarcieritarcieri changed the title [WIP] der: remove lifetime from OctetStringRefder: remove lifetime from OctetStringRefSep 15, 2025
@tarcieri
tarcieri marked this pull request as ready for review September 15, 2025 19:27
tarcieri
tarcieri commented Sep 15, 2025
View reviewed changes
Comment threadder/src/asn1/octet_string.rs
Comment on lines +8 to +10
// TODO(tarcieri): custom derive hack until the logic is updated to support `&'a` reference types
#[doc(hidden)]
pub type OctetStringRef2<'a> = &'a OctetStringRef;

@tarcieritarcieriSep 15, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one of the hacks. I didn't implement special case support for &'a MyRef types in der_derive yet, so this hack lets it use the old syntax.

@tarcieri
der: remove lifetime from OctetStringRef
77c4d20
Following the pattern of #1921, removes the lifetime from the struct,
instead changing `OctetStringRef` to a proper reference type to be used
as `&OctetStringRef`.
This makes it possible to `impl Borrow<OctetStringRef> for OctetString`
and `impl ToOwned for OctetStringRef`, so they can work with `Cow`.
@tarcieri
tarcieriforce-pushed the der/remove-octet-string-ref-lifetime branch from 2a06eca to 77c4d20CompareSeptember 15, 2025 19:30
@tarcieri

tarcieri commented Sep 15, 2025•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Gonna land this. We can work through custom derive support separately. I'll make an issue about it.

Edit: opened #2039

@tarcieri
tarcieri merged commit 3d56da5 into masterSep 15, 2025
107 checks passed
@tarcieri
tarcieri deleted the der/remove-octet-string-ref-lifetime branch September 15, 2025 19:43
@tarcieritarcieri mentioned this pull request Sep 15, 2025
Closed
tarcieri added a commit that referenced this pull request Sep 15, 2025
@tarcieri
der: rename OctetStringRefDeriveHack
7728790
This is a temporary type introduced in #1998 until `der_derive` can be
updated to use the new type shape (see #2039).
@tarcieritarcieri mentioned this pull request Sep 15, 2025
Merged
tarcieri added a commit that referenced this pull request Sep 15, 2025
@tarcieri
der: renameOctetStringRefDeriveHack(#2040)
f7905f1
This is a temporary type introduced in #1998 until `der_derive` can be
updated to use the new type shape (see #2039).
@tarcieritarcieri mentioned this pull request Feb 11, 2026
Merged
tarcieri added a commit that referenced this pull request Feb 11, 2026
@tarcieri
der_derive v0.8.0 (#2226)
8425274
## Added
- `Sequence`, `Enumerated` and `Choice` macros now support `#[asn1(error = Ty)]`
attribute that provides a custom error type for `Decode`/`DecodeValue`
implementations (#1560)
- `BitString` macro (#1720, #1733)
- `DecodeValue`, `EncodeValue` macros (#1722)
- Derive support for `APPLICATION` and `PRIVATE` tags (#1825)
- Impl `DecodeValue` for `Choice` (#1986)
## Changed
- Use `TryFrom` conversions for `asn1(type = ...)` (#1562)
- Rewrite `EncodeValue::value_len` as simple addition (#1810)
- Change OctetStringRef `&` handling due to `der` type changes
(#1998, #2040, #2043)
@tarcieritarcieri mentioned this pull request Feb 13, 2026
Merged
tarcieri added a commit that referenced this pull request Feb 13, 2026
@tarcieri
der v0.8.0 (#2234)
7784544
## Added
- Custom error types support to the `Decode` and `DecodeValue` traits (#1055)
- `EncodingRules` enum (#1321)
- `Decode::from_ber` (#1389)
- Documentation for field-level `tag_mode` attribute (#1401)
- `Hash` implementation for `AlgorithmIdentifier` (#1414)
- `SequenceRef::as_bytes` and `AsRef<[u8]>` impl (#1454)
- `Reader::peek_into` (#1478)
- `GeneralString` variant to `Tag` (#1512)
- Conversions from `OctetString(Ref)` to `Vec`/`Bytes` (#1540)
- Custom error types in derive macros (#1560)
- Support for tags beyond 30 (#1651)
- Const `::new` to `Length`, `BytesRef`, and `AnyRef` (#1713)
- Const `GeneralizedTime::from_date_time` (#1718)
- `Decode::from_der_partial` (#1725)
- Conversions between `BitStringRef`/`OctetStringRef` and `[u8; N]` (#1731)
- Add class bits consts for Application and Private tag support (#1721)
- conversions between `heapless:Vec<u8>` and `OctetStringRef` (#1735)
- `IsConstructed` trait, impl'ed on any `FixedTag` (#1744)
- Implement `Hash` for `SetOf` (#1764)
- Implement `Uint`/`Int` conversions from native types (#1762)
- Support for `APPLICATION`, `CONTEXT-SPECIFIC` and `PRIVATE` tags (#1819, #1825, #1944)
- Support `Cow<[u8]>` in `derive(Sequence)` (#1850)
- `diagnostic::on_unimplemented` attributes (#1876)
- `Reader::read_value`, auto-nest `DecodeValue` (#1877, #1895, #1897, #1901)
- Indefinite length support for BER (#1884, #1885, #1894, #1900, #1902, #1910)
- Constructed OctetString support (#1899, #1922)
- string conversions, predicate methods for EncodingRules (#1903, #1953)
- `Any::header` (#1935)
- `Tag::RelativeOid` (#1942)
- `ber` feature (#1948, #1950)
- Hash derive for `StringOwned` and `Ia5String` (#1973)
- Implement `DecodeValue/EncodeValue/Tagged` for `Cow` (#2093)
- Add doc examples for `EncodeValue`, `Encode`, `DecodeValue`, `Decode`, `Error`, `ErrorKind`, `Tagged`, `FixedTag`,
`IsConstructed`, `Tag`, `Length`, `Header` (#2075, #2071, #2070, #2064, #2058, #2052, #2053, #2051)
- `SequenceRef::new` (#2224)
## Changed
- Return `Tag::Integer.length_error()` on empty ints (#1400)
- Allow all blanket impls on `?Sized` types (#1451)
- Refactor `Tag::peek` (#1479)
- Refactor `Header::peek` (#1480)
- Use `core::error::Error` (#1553)
- Use 2024 edition, bump MSRV to 1.85 (#1670)
- Bump `const-oid` to v0.10 (#1676)
- Reject zero lengths reads (#1716)
- Deprecate `TagNumber::new` (#1727)
- Use strict context-specific skipping condition (equal tag numbers only) (#1740)
- Const `Any::to_ref`, `BytesOwned::to_ref` (#1797)
- Return `ErrorKind::Noncanonical` in `EXPLICIT` when primitive (#1818)
- Use `read_nested` to check length of `IMPLICIT` types (#1739)
- Simplify `From<&UintRef<'a>>` for `Uint` (#1840)
- Make `ObjectIdentifier<MAX_SIZE>` impls generic (#1851)
- Extract `reader::position::Position` (#1880)
- Make `Reader` cloneable (#1883)
- Simplify `Header::peek` and `Tag::peek` (#1886)
- Improve constructed bit handling (#1919)
- Use fat pointer in `OctetStringRef`, consolidate bytes/string modules, improve internal ref types
(#1920, #1921, #1998, #2040)
- Change constructor `Header::new`, add `Header::with_length`, tests for constructed octet string (#1931, #1930)
- Simplify `der_cmp` for `Length` (#1997)
- Rename variable encoder -> writer and improve example (#2078)
- Have `PemReader` decode to `Cow::Owned` (#2094)
- Only sort `SET OF` types with `EncodingRules::Der` (#2219)
- `SetOf` and `SequenceOf` now require `heapless` feature (#2220, #2229)
## Fixed
- Append in `Encode::encode_to_vec` (#1760)
- Derive optional OCTET/BIT STRING on `Option<&[u8]>` (#1737)
- X.680 tag order: compare class and number first (#1790)
- BMPString compatibility in derive macros (#1793)
- `Tag::peek_optional` for 6-byte and 7+ byte tags (#1804)
- `Header::peek` for 11-byte tag-lengths (#1828)
- Panic in `value_cmp`: add `Iterator::size_hint` (#1830)
- Error position tracking improvements (#1889, #2080, #2079)
- Bound `Decode(Value)::Error` on `core::error::Error` (#2137)
- Have `SetOf(Vec)::insert` check for duplicates (#2217)
## Removed
- `TagNumber::N0..N30` consts (#1724)
- 256MiB limit on `Length` (#1726)
- Generic `<T>` from `Reader::finish` (#1833)
- Deprecated `SetOf(Vec)::add` methods (#2232)
- `SequenceRef` lifetime (#2224)
This was referenced Apr 22, 2026
Closed
Closed
tarcieri added a commit that referenced this pull request Apr 23, 2026
@tarcieri
[WIP] der: remove lifetime from BitStringRef [BREAKING]
0977fc1
Following the pattern of #1921 and what #1998 did for `OctetStringRef`,
this removes the lifetime from the struct, instead changing
`BitStringRef` to a proper reference type to be used as `&BitStringRef`,
which can implement the `Borrow` and `ToOwned` patterns needed to work
with `Cow`.
To make this work, this uses a hack described in #2298 where we abuse
a fat pointer, namely a ZST slice `[UnsafeCell<()>]`, to carry the
pointer to the `*const u8` buffer that backs the `BitStringRef`, and
carries the bit length along as the length of the ZST slice.
To get the original byte length back we can `div_ceil(8)` and then
reconstruct the original `[u8]`.
tarcieri added a commit that referenced this pull request Apr 23, 2026
@tarcieri
[WIP] der: remove lifetime from BitStringRef [BREAKING]
5819bf0
Following the pattern of #1921 and what #1998 did for `OctetStringRef`,
this removes the lifetime from the struct, instead changing
`BitStringRef` to a proper reference type to be used as `&BitStringRef`,
which can implement the `Borrow` and `ToOwned` patterns needed to work
with `Cow`.
To make this work, this uses a hack described in #2298 where we abuse
a fat pointer, namely a ZST slice `[UnsafeCell<()>]`, to carry the
pointer to the `*const u8` buffer that backs the `BitStringRef`, and
carries the bit length along as the length of the ZST slice.
To get the original byte length back we can `div_ceil(8)` and then
reconstruct the original `[u8]`.
tarcieri added a commit that referenced this pull request Apr 23, 2026
@tarcieri
[WIP] der: remove lifetime from BitStringRef [BREAKING]
3bfb774
Following the pattern of #1921 and what #1998 did for `OctetStringRef`,
this removes the lifetime from the struct, instead changing
`BitStringRef` to a proper reference type to be used as `&BitStringRef`,
which can implement the `Borrow` and `ToOwned` patterns needed to work
with `Cow`.
To make this work, this uses a hack described in #2298 where we abuse
a fat pointer, namely a ZST slice `[UnsafeCell<()>]`, to carry the
pointer to the `*const u8` buffer that backs the `BitStringRef`, and
carries the bit length along as the length of the ZST slice.
To get the original byte length back we can `div_ceil(8)` and then
reconstruct the original `[u8]`.
tarcieri added a commit that referenced this pull request Apr 23, 2026
@tarcieri
[WIP] der: remove lifetime from BitStringRef [BREAKING]
d9463a2
Following the pattern of #1921 and what #1998 did for `OctetStringRef`,
this removes the lifetime from the struct, instead changing
`BitStringRef` to a proper reference type to be used as `&BitStringRef`,
which can implement the `Borrow` and `ToOwned` patterns needed to work
with `Cow`.
To make this work, this uses a hack described in #2298 where we abuse
a fat pointer, namely a ZST slice `[UnsafeCell<()>]`, to carry the
pointer to the `*const u8` buffer that backs the `BitStringRef`, and
carries the bit length along as the length of the ZST slice.
To get the original byte length back we can `div_ceil(8)` and then
reconstruct the original `[u8]`.
tarcieri added a commit that referenced this pull request Apr 24, 2026
@tarcieri
[WIP] der: remove lifetime from BitStringRef [BREAKING]
6bf8653
Following the pattern of #1921 and what #1998 did for `OctetStringRef`,
this removes the lifetime from the struct, instead changing
`BitStringRef` to a proper reference type to be used as `&BitStringRef`,
which can implement the `Borrow` and `ToOwned` patterns needed to work
with `Cow`.
To make this work, this uses a hack described in #2298 where we abuse
a fat pointer, namely a ZST slice `[UnsafeCell<()>]`, to carry the
pointer to the `*const u8` buffer that backs the `BitStringRef`, and
carries the bit length along as the length of the ZST slice.
To get the original byte length back we can `div_ceil(8)` and then
reconstruct the original `[u8]`.
tarcieri added a commit that referenced this pull request Apr 24, 2026
@tarcieri
[WIP] der: remove lifetime from BitStringRef [BREAKING]
be413f1
Following the pattern of #1921 and what #1998 did for `OctetStringRef`,
this removes the lifetime from the struct, instead changing
`BitStringRef` to a proper reference type to be used as `&BitStringRef`,
which can implement the `Borrow` and `ToOwned` patterns needed to work
with `Cow`.
To make this work, this uses a hack described in #2298 where we abuse
a fat pointer, namely a ZST slice `[UnsafeCell<()>]`, to carry the
pointer to the `*const u8` buffer that backs the `BitStringRef`, and
carries the bit length along as the length of the ZST slice.
To get the original byte length back we can `div_ceil(8)` and then
reconstruct the original `[u8]`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@baloobalooAwaiting requested review from baloo
1 more reviewer
@dishmakerdishmakerdishmaker left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tarcieri@dishmaker