github-webhooks 0.1.0-alpha.0

Utilities for handling GitHub webhooks in various Rust web frameworks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

pub type Result<T, E = ToEventError> = std::result::Result<T, E>;

/// Errors that can occur when converting a `GithubWebhook` into an `Event`.
#[derive(thiserror::Error, Debug)]
pub enum ToEventError {
	/// The `X-Hub-Signature-256` header is invalid &mdash; it couldn't be decoded.
	#[error("X-Hub-Signature-256 header is invalid")]
	InvalidSignature(#[from] hex::FromHexError),

	/// When parsing the `X-Github-Event` header, into an `EventType`, it fails.
	#[error("Failed to parse payload, type: {r#type}")]
	InvalidEventType { r#type: String },

	/// When parsing the payload into an `Event`, it fails.
	#[error("Failed to parse the payload into `github::Event`")]
	ParseFailed,

	/// When verifying the signature, it fails.
	#[error("Failed to verify the signature")]
	VerifySignatureFailed,
}