Skip to content

Commit d012e2c

Browse files
mcrdjc
authored andcommitted
doc: extend CertificateSigningRequest docs/interinks
Updates description to point to `CertificateParams`, `KeyPair`, `SigningKey` for additional explanation.
1 parent 0c565ed commit d012e2c

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

rcgen/src/csr.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ impl PublicKeyData for PublicKey {
3737
}
3838

3939
/// A certificate signing request (CSR) that can be encoded to PEM or DER.
40+
///
41+
/// A new certificate signing request is created by filling out a [`CertificateParams`] object
42+
/// and then calling [`CertificateParams::serialize_request()`] or
43+
/// [`CertificateParams::serialize_request_with_attributes()`] with a
44+
/// [`crate::KeyPair`] (or other [`SigningKey`] capable trait).
4045
#[derive(Clone, Debug, PartialEq, Eq)]
4146
pub struct CertificateSigningRequest {
4247
pub(crate) der: CertificateSigningRequestDer<'static>,

0 commit comments

Comments
 (0)