Skip to content

der: add docs for Error and ErrorKind #2058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 9, 2025
Merged

der: add docs for Error and ErrorKind #2058

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
823169f
der: add docs for `Error` and `ErrorKind`
dishmaker Oct 7, 2025
69940de
der: reader.error(..) example
dishmaker Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions der/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,22 @@ use crate::pem;
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
///
/// ## Example
/// ```
/// use der::{Decode, ErrorKind, Reader};
///
/// struct MyDecodable;
///
/// impl<'a> Decode<'a> for MyDecodable {
/// type Error = der::Error;
///
/// fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self, der::Error> {
/// // Error implements From<ErrorKind>
/// Err(ErrorKind::OidMalformed.into())
/// }
/// }
/// ```
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub struct Error {
/// Kind of error.
Expand Down Expand Up @@ -162,6 +178,15 @@ impl From<time::error::ComponentRange> for Error {
}

/// Error type.
///
/// # Example
/// ```
/// use der::{asn1::OctetStringRef, Decode, ErrorKind};
///
/// let err = <&OctetStringRef>::from_der(&[0x04, 0x80, 0x00]).unwrap_err();
///
/// assert_eq!(err.kind(), ErrorKind::IndefiniteLength);
/// ```
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum ErrorKind {
Expand Down