surrealdb-core 3.2.0

A scalable, distributed, collaborative, document-graph database, for the realtime web
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

/// Macro to create an parser error.
///
/// This creates an error with a message first and then a number of spans,
/// possibly with a label.
///
/// # Example
///
/// ```ignore
/// let text = "As we all know 1+1 is 3.";
/// if text.contains("3"){
///     let span = Span::empty(); // just imagine there is an actual span here.
///     error!("1 + 1 should be {}",1+1, @span => "your wrong here!");
///     // This will return the following error when rendered:
///     // Error: 1 + 1 should be 2
///     //   |
///     // 1 | As we all know 1+1 is 3.
///     //   |                       ^ your wrong here!
/// }
/// ```
macro_rules! syntax_error {
	($format:literal $(, $expr:expr_2021)*
		$(, @ $span:expr_2021 $(=> $label_format:literal $(, $label_expr:expr_2021)* $(,)? )? )*
	) => {{
		let __error: $crate::syn::error::SyntaxError = $crate::syn::error::SyntaxError::new(format_args!($format $(, $expr)*));
		$(
			$crate::syn::error::syntax_error!(#label __error, $span $(=> $label_format$(, $label_expr)*  )?);
		)*
		__error
	}};

	(#label $name:ident, $span:expr_2021 => $label_format:literal $(, $label_expr:expr_2021)* ) => {
		let $name = $name.with_labeled_span($span,$crate::syn::error::MessageKind::Error, format_args!($label_format $(, $label_expr)*));
	};

	(#label $name:ident, $span:expr_2021 ) => {
	    let $name = $crate::syn::error::SyntaxError::with_span($name,$span, $crate::syn::error::MessageKind::Error);
	};
}

/// Similar to [`error`] but immediately returns the error.
///
/// Macro to create and return a parser error.
///
/// This creates an error with a message first and then a number of spans,
/// possibly with a label.
///
/// # Example
///
/// ```ignore
/// let text = "As we all know 1+1 is 3.";
/// if text.contains("3"){
///     let span = Span::empty(); // just imagine there is an actual span here.
///     bail!("1 + 1 should be {}",1+1, @span => "your wrong here!");
///     // This will return the following error when rendered:
///     // Error: 1 + 1 should be 2
///     //   |
///     // 1 | As we all know 1+1 is 3.
///     //   |                       ^ your wrong here!
/// }
/// ```
macro_rules! bail {
	($($t:tt)*) => {{
		let __error = $crate::syn::error::syntax_error!($($t)*);
		return Err(__error)
	}};
}

pub(crate) use bail;
pub(crate) use syntax_error;