Unverified Commit 6bb54e01 authored by Steven Fackler's avatar Steven Fackler Committed by GitHub
Browse files

Merge pull request #764 from AndyGauge/doc-error

Doc error
parents 8e0b69aa 829c8055
Loading
Loading
Loading
Loading
+20 −0
Original line number Diff line number Diff line
//! Errors returned by OpenSSL library.
//!
//! OpenSSL errors are stored in an `ErrorStack`.  Most methods in the crate
//! returns a `Result<T, ErrorStack>` type.
//!
//! # Examples
//!
//! ```
//! use openssl::error::ErrorStack;
//! use openssl::bn::BigNum;
//!
//! let an_error = BigNum::from_dec_str("Cannot parse letters");
//! match an_error {
//!     Ok(_)  => (),
//!     Err(e) => println!("Parsing Error: {:?}", e),
//! }
//! ```
use libc::{c_ulong, c_char, c_int};
use std::fmt;
use std::error;
@@ -9,6 +26,9 @@ use std::borrow::Cow;

use ffi;

/// Collection of [`Error`]s from OpenSSL.
///
/// [`Error`]: struct.Error.html
#[derive(Debug, Clone)]
pub struct ErrorStack(Vec<Error>);