rivet-error 2.3.1

Structured error helpers for Rivet
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use crate::error::{RivetError, RivetErrorKind};
use serde::Serialize;
use std::marker::PhantomData;

/// Private marker type that proves an error was created through the macro
#[derive(Debug)]
pub struct MacroMarker {
	pub _private: (),
}

/// Can only be created through the rivet_error macro.
#[derive(Debug)]
pub struct RivetErrorSchema {
	pub group: &'static str,
	pub code: &'static str,
	pub default_message: &'static str,
	#[allow(dead_code)]
	pub meta_type: Option<&'static str>,
	/// Private marker that ensures this was created by the macro
	pub _macro_marker: MacroMarker,
}

/// Can only be created through the rivet_error macro.
#[derive(Debug)]
pub struct RivetErrorSchemaWithMeta<T> {
	pub schema: RivetErrorSchema,
	pub message_fn: fn(&T) -> String,
	pub _phantom: PhantomData<T>,
}

impl RivetErrorSchema {
	/// Internal constructor for built-in errors only (like INTERNAL_ERROR)
	#[doc(hidden)]
	pub(crate) const fn __internal_new(
		group: &'static str,
		code: &'static str,
		message: &'static str,
	) -> Self {
		Self {
			group,
			code,
			default_message: message,
			meta_type: None,
			_macro_marker: MacroMarker { _private: () },
		}
	}

	/// Builds an anyhow::Error from this schema
	pub fn build(&'static self) -> anyhow::Error {
		let error = RivetError {
			kind: RivetErrorKind::Static(self),
			meta: None,
			message: None,
			actor: None,
		};
		anyhow::Error::new(error)
	}

	pub(crate) fn build_internal(&'static self, error: &anyhow::Error) -> RivetError {
		RivetError::build_internal(error)
	}
}

impl<T: Serialize> RivetErrorSchemaWithMeta<T> {
	/// Builds an anyhow::Error from this schema with the provided metadata
	pub fn build_with(&'static self, meta: T) -> anyhow::Error {
		let message = (self.message_fn)(&meta);
		let meta_json = serde_json::value::to_raw_value(&meta).ok();

		let error = RivetError {
			kind: RivetErrorKind::Static(&self.schema),
			meta: meta_json,
			message: Some(message),
			actor: None,
		};
		anyhow::Error::new(error)
	}
}

impl From<&'static RivetErrorSchema> for RivetError {
	fn from(value: &'static RivetErrorSchema) -> Self {
		RivetError {
			kind: RivetErrorKind::Static(value),
			meta: None,
			message: None,
			actor: None,
		}
	}
}