Skip to content

Commit 1e4a20e

Browse files
committed
Add Rustdoc for errors.
1 parent ccbdf3b commit 1e4a20e

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,14 +144,19 @@ impl Display for FieldInfo {
144144
/// An error decoding an ESR value.
145145
#[derive(Debug, Error)]
146146
pub enum DecodeError {
147+
/// A RES0 field was not 0.
147148
#[error("Invalid ESR, res0 is {res0:#x}")]
148149
InvalidRes0 { res0: u64 },
150+
/// The EC field had an invalid value.
149151
#[error("Invalid EC {ec:#x}")]
150152
InvalidEc { ec: u64 },
153+
/// The DFSC or IFSC field had an invalid value.
151154
#[error("Invalid DFSC or IFSC {fsc:#x}")]
152155
InvalidFsc { fsc: u64 },
156+
/// The SET field had an invalid value.
153157
#[error("Invalid SET {set:#x}")]
154158
InvalidSet { set: u64 },
159+
/// The AM field had an invalid value.
155160
#[error("Invalid AM {am:#x}")]
156161
InvalidAm { am: u64 },
157162
}

0 commit comments

Comments
 (0)