chore: displaydoc

Author: apskhem

rust/catalyst-types/Cargo.toml

@@ -18,6 +18,7 @@ name = "catalyst_types"
 [dependencies]
 blake2b_simd = "1.0.2"
 coset = "0.3.8"
+displaydoc = "0.2.5"
 ed25519-dalek = "2.1.1"
 fluent-uri = "0.3.2"
 hex = "0.4.3"

rust/catalyst-types/src/conversion.rs

@@ -1,20 +1,19 @@
 //! Conversion functions
 
+use displaydoc::Display;
 use thiserror::Error;
 
 /// Errors that can occur when converting bytes to an Ed25519 verifying key.
-#[derive(Debug, Error)]
+#[derive(Display, Debug, Error)]
 pub enum VKeyFromBytesError {
-    /// Indicates the provided byte slice has an invalid length.
-    #[error("Invalid byte length: expected {expected} bytes, got {actual}")]
+    /// Invalid byte length: expected {expected} bytes, got {actual}
     InvalidLength {
         /// The expected number of bytes (must be 32).
         expected: usize,
         /// The actual number of bytes in the provided input.
         actual: usize,
     },
-    /// Indicates that the bytes could not be parsed into an Ed25519 public key.
-    #[error("Failed to parse Ed25519 public key: {source}")]
+    /// Failed to parse Ed25519 public key: {source}
     ParseError {
         /// The underlying error from `ed25519_dalek`.
         #[from]

rust/catalyst-types/src/hashes.rs

@@ -3,6 +3,7 @@
 use std::{fmt, str::FromStr};
 
 use blake2b_simd::Params;
+use displaydoc::Display;
 use pallas_crypto::hash::Hash;
 use thiserror::Error;
 
@@ -25,19 +26,16 @@ pub const BLAKE_2B128_SIZE: usize = 128 / 8;
 pub type Blake2b128Hash = Blake2bHash<BLAKE_2B128_SIZE>;
 
 /// Errors that can occur when converting to a `Blake2bHash`.
-#[derive(Debug, Error)]
+#[derive(Display, Debug, Error)]
 pub enum Blake2bHashError {
-    /// Indicates that the input byte slice has invalid length of bytes to create a valid
-    /// hash.
-    #[error("Invalid length: expected {expected} bytes, got {actual}")]
+    /// Invalid length: expected {expected} bytes, got {actual}
     InvalidLength {
         /// The expected number of bytes (must be 32 or 28).
         expected: usize,
         /// The actual number of bytes in the provided input.
         actual: usize,
     },
-    /// The input string is not a valid hex-encoded string.
-    #[error("Invalid hex string: {source}")]
+    /// Invalid hex string: {source}
     InvalidHex {
         /// The underlying error from `hex`.
         #[from]

rust/catalyst-types/src/kid_uri/errors.rs

@@ -1,43 +1,33 @@
 //! Errors returned by this type
 
+use displaydoc::Display;
 use thiserror::Error;
 
 use super::{key_rotation::KeyRotationError, role_index::RoleIndexError};
 
 /// Errors that can occur when parsing a `KidUri`
-#[derive(Error, Debug)]
+#[derive(Display, Error, Debug)]
 pub enum KidUriError {
     /// Invalid KID URI
-    #[error("Invalid URI")]
     InvalidURI(#[from] fluent_uri::error::ParseError),
     /// Invalid Scheme, not a KID URI
-    #[error("Invalid Scheme, not a KID URI")]
     InvalidScheme,
     /// Network not defined in URI
-    #[error("No defined Network")]
     NoDefinedNetwork,
     /// Path of URI is invalid
-    #[error("Invalid Path")]
     InvalidPath,
     /// Role 0 Key in path is invalid
-    #[error("Invalid Role 0 Key")]
     InvalidRole0Key,
     /// Role 0 Key in path is not encoded correctly
-    #[error("Invalid Role 0 Key Encoding")]
     InvalidRole0KeyEncoding(#[from] base64_url::base64::DecodeError),
     /// Role Index is invalid
-    #[error("Invalid Role")]
     InvalidRole,
     /// Role Index is not encoded correctly
-    #[error("Invalid Role Index")]
     InvalidRoleIndex(#[from] RoleIndexError),
     /// Role Key Rotation is invalid
-    #[error("Invalid Rotation")]
     InvalidRotation,
     /// Role Key Rotation is not encoded correctly
-    #[error("Invalid Rotation Value")]
     InvalidRotationValue(#[from] KeyRotationError),
     /// Encryption key Identifier Fragment is not valid
-    #[error("Invalid Encryption Key Fragment")]
     InvalidEncryptionKeyFragment,
 }

rust/catalyst-types/src/kid_uri/key_rotation.rs

@@ -6,14 +6,14 @@ use std::{
     str::FromStr,
 };
 
+use displaydoc::Display;
 use thiserror::Error;
 
 /// Errors from parsing the `KeyRotation`
-#[derive(Error, Debug)]
+#[derive(Display, Error, Debug)]
 #[allow(clippy::module_name_repetitions)]
 pub enum KeyRotationError {
-    /// Key Rotation could not be parsed from a string
-    #[error("Invalid Role Key Rotation")]
+    /// Invalid Role Key Rotation
     InvalidRole(#[from] ParseIntError),
 }
 

rust/catalyst-types/src/kid_uri/role_index.rs

@@ -6,14 +6,14 @@ use std::{
     str::FromStr,
 };
 
+use displaydoc::Display;
 use thiserror::Error;
 
 /// Role Index parsing error
-#[derive(Error, Debug)]
+#[derive(Display, Error, Debug)]
 #[allow(clippy::module_name_repetitions)]
 pub enum RoleIndexError {
-    /// Failed to parse the role index
-    #[error("Invalid Role Index")]
+    /// Invalid Role Index
     InvalidRole(#[from] ParseIntError),
 }
 

rust/catalyst-types/src/uuid/mod.rs

@@ -1,5 +1,6 @@
 //! `UUID` types.
 
+use displaydoc::Display;
 use thiserror::Error;
 use uuid::Uuid;
 
@@ -16,16 +17,13 @@ pub const INVALID_UUID: uuid::Uuid = uuid::Uuid::from_bytes([0x00; 16]);
 pub const UUID_CBOR_TAG: u64 = 37;
 
 /// Errors that can occur when decoding CBOR-encoded UUIDs.
-#[derive(Debug, Error)]
+#[derive(Display, Debug, Error)]
 pub enum CborUuidError {
-    /// Indicates that the CBOR value is not a valid UUID tag.
-    #[error("Invalid CBOR encoded UUID type")]
+    /// Invalid CBOR encoded UUID type
     InvalidCborType,
-    /// Indicates that the byte slice has an invalid size for a UUID.
-    #[error("Invalid CBOR encoded UUID type: invalid bytes size")]
+    /// Invalid CBOR encoded UUID type: invalid bytes size
     InvalidByteSize,
-    /// Indicates that the UUID version does not match the expected version.
-    #[error("UUID {uuid} is not `v{expected_version}`")]
+    /// UUID {uuid} is not `v{expected_version}`
     InvalidVersion {
         /// The decoded UUID that was checked.
         uuid: Uuid,