behaviortree 0.7.4

A #![no_std] compatible behavior tree library similar to 'BehaviorTree.CPP'.
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

// Copyright © 2024 Stephan Kunz

//! [`behaviortree`](crate) errors.

#[doc(hidden)]
extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

use alloc::boxed::Box;

// region:		--- types
/// Result type definition for behavior trees.
pub type BehaviorTreeResult<Output = crate::behavior::BehaviorState> = Result<Output, Error>;
// endregion:   --- types

/// `factory` error type
#[non_exhaustive]
pub struct Error {
	/// Module name
	module: &'static str,
	/// Original error
	source: Box<dyn core::error::Error>,
}

/// Only a source implementation needed.
impl core::error::Error for Error {
	fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
		Some(self.source.as_ref())
	}

	// fn cause(&self) -> Option<&dyn core::error::Error> {
	// 	self.source()
	// }

	// fn provide<'a>(&'a self, request: &mut core::error::Request<'a>) {}
}

impl core::fmt::Debug for Error {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
		write!(f, "Behaviortree(module: {}, error: {}", self.module, self.source)
	}
}

impl core::fmt::Display for Error {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
		write!(f, "Behaviortree module '{}' failed with: {}", self.module, self.source)
	}
}

impl From<crate::behavior::error::Error> for Error {
	fn from(source: crate::behavior::error::Error) -> Self {
		Self {
			module: "behavior",
			source: Box::new(source),
		}
	}
}

impl From<crate::factory::error::Error> for Error {
	fn from(source: crate::factory::error::Error) -> Self {
		Self {
			module: "factory",
			source: Box::new(source),
		}
	}
}

impl From<crate::tree::error::Error> for Error {
	fn from(source: crate::tree::error::Error) -> Self {
		Self {
			module: "tree",
			source: Box::new(source),
		}
	}
}

impl From<databoard::Error> for Error {
	fn from(source: databoard::Error) -> Self {
		Self {
			module: "databoard",
			source: Box::new(source),
		}
	}
}

impl From<woxml::Error> for Error {
	fn from(source: woxml::Error) -> Self {
		Self {
			module: "woxml",
			source: Box::new(source),
		}
	}
}

#[cfg(feature = "std")]
impl From<std::io::Error> for Error {
	fn from(source: std::io::Error) -> Self {
		Self {
			module: "std::io",
			source: Box::new(source),
		}
	}
}