Fix doc test and move external documentation link to rand_bytes function

This commit is contained in:
johnthagen 2017-09-28 10:36:53 -04:00
parent 26fa22fe04
commit c4b044b6ba
1 changed files with 19 additions and 9 deletions

View File

@ -1,20 +1,15 @@
//! Cryptographically strong random bytes. //! Utilities for secure random number generation.
//!
//! This module exposes functionality to put cryptographically strong
//! pseudo-random bytes into a buffer.
//! //!
//! # Examples //! # Examples
//! //!
//! To generate a buffer with cryptographically strong bytes: //! To generate a buffer with cryptographically strong bytes:
//! //!
//! ``` //! ```
//! let muf buf = [0; 256]; //! use openssl::rand::rand_bytes;
//!
//! let mut buf = [0; 256];
//! rand_bytes(&mut buf).unwrap(); //! rand_bytes(&mut buf).unwrap();
//! ``` //! ```
//!
//! # External OpenSSL Documentation
//!
//! [RAND_bytes](https://www.openssl.org/docs/man1.1.0/crypto/RAND_bytes.html)
use libc::c_int; use libc::c_int;
use ffi; use ffi;
@ -22,6 +17,21 @@ use cvt;
use error::ErrorStack; use error::ErrorStack;
/// Fill buffer with cryptographically strong pseudo-random bytes. /// Fill buffer with cryptographically strong pseudo-random bytes.
///
/// # Examples
///
/// To generate a buffer with cryptographically strong bytes:
///
/// ```
/// use openssl::rand::rand_bytes;
///
/// let mut buf = [0; 256];
/// rand_bytes(&mut buf).unwrap();
/// ```
///
/// # External OpenSSL Documentation
///
/// [RAND_bytes](https://www.openssl.org/docs/man1.1.0/crypto/RAND_bytes.html)
pub fn rand_bytes(buf: &mut [u8]) -> Result<(), ErrorStack> { pub fn rand_bytes(buf: &mut [u8]) -> Result<(), ErrorStack> {
unsafe { unsafe {
ffi::init(); ffi::init();