Unverified Commit 558cbd01 authored by Wiktor Kwapisiewicz's avatar Wiktor Kwapisiewicz
Browse files

Fix documentation example for `Rsa::from_private_components` 

The existing documentation probably went out of sync when refactoring
`Rsa` into `RsaPrivateKeyBuilder`.

This change fixes the example by using code similar to the actual
implementation. Additionally the example has been converted to a doctest
so that any future refactorings should be captured by the test.
parent ff5397d4

openssl/src/rsa.rs

+12 −2
Original line number Diff line number Diff line
@@ -490,8 +490,18 @@ impl RsaPrivateKeyBuilder { 
impl Rsa<Private> {

    /// Creates a new RSA key with private components (public components are assumed).

    ///

    /// This a convenience method over

    /// `Rsa::build(n, e, d)?.set_factors(p, q)?.set_crt_params(dmp1, dmq1, iqmp)?.build()`

    /// This a convenience method over:

    /// ```

    /// # use openssl::rsa::RsaPrivateKeyBuilder;

    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {

    /// # let bn = || openssl::bn::BigNum::new().unwrap();

    /// # let (n, e, d, p, q, dmp1, dmq1, iqmp) = (bn(), bn(), bn(), bn(), bn(), bn(), bn(), bn());

    /// RsaPrivateKeyBuilder::new(n, e, d)?

    ///     .set_factors(p, q)?

    ///     .set_crt_params(dmp1, dmq1, iqmp)?

    ///     .build();

    /// # Ok(()) }

    /// ```

    #[allow(clippy::too_many_arguments, clippy::many_single_char_names)]

    pub fn from_private_components(

        n: BigNum,