From 79d12268d75c1190862596910778f4394d2604fc Mon Sep 17 00:00:00 2001 From: Joe Birr-Pixton Date: Mon, 23 Dec 2024 13:30:11 +0000 Subject: [PATCH] AlgorithmIdentifier: cross-reference to alg_id module --- src/lib.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 335e0e9..e594bda 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -915,7 +915,8 @@ pub struct InvalidSignature; /// The outer sequence encoding is *not included*, so this is the DER encoding /// of an OID for `algorithm` plus the `parameters` value. /// -/// For example, this is the `rsaEncryption` algorithm: +/// For example, this is the `rsaEncryption` algorithm (but prefer to use the constant +/// [`alg_id::RSA_ENCRYPTION`] instead): /// /// ``` /// let rsa_encryption = rustls_pki_types::AlgorithmIdentifier::from_slice( @@ -927,6 +928,8 @@ pub struct InvalidSignature; /// ] /// ); /// ``` +/// +/// Common values for this type are provided in the [`alg_id`] module. #[derive(Clone, Copy, PartialEq, Eq)] pub struct AlgorithmIdentifier(&'static [u8]);