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

// Copyright © 2025 Stephan Kunz

//! [`behaviortree`](crate) [`PortDefinition`] implementation.

// region:      --- modules
use crate::ConstString;

use super::{error::Error, is_allowed_port_name, port_direction::PortDirection};
// endregion:   --- modules

// region:      --- PortDefinition
/// A [`PortDefinition`], which is used for configuration.
#[derive(Clone, Debug)]
pub struct PortDefinition {
	/// Direction of the port.
	direction: PortDirection,
	/// Data type of the port.
	/// This is a `&'static str`, created by the port creation macro.
	type_name: &'static str,
	/// Name of the port.
	/// This has to be a `&'static str`.
	name: &'static str,
	/// Default value for the port.
	default_value: ConstString,
	/// Description of the port.
	/// This has to be a `&'static str`.
	description: &'static str,
}

impl PortDefinition {
	/// Constructor
	/// # Errors
	/// - if the name violates the conventions.
	pub fn new(
		direction: PortDirection,
		type_name: &'static str,
		name: &'static str,
		default_value: &str,
		description: &'static str,
	) -> Result<Self, Error> {
		if is_allowed_port_name(name) {
			Ok(Self {
				direction,
				type_name,
				name,
				default_value: default_value.into(),
				description,
			})
		} else {
			Err(Error::NameNotAllowed { port: name.into() })
		}
	}

	/// Get the [`PortDefinition`]s name.
	#[must_use]
	pub const fn name(&self) -> &'static str {
		self.name
	}

	/// Get the [`PortDefinition`]s direction.
	#[must_use]
	pub const fn direction(&self) -> &PortDirection {
		&self.direction
	}

	/// Get the default value.
	#[must_use]
	pub fn default_value(&self) -> Option<&ConstString> {
		if self.default_value.is_empty() {
			None
		} else {
			Some(&self.default_value)
		}
	}

	#[must_use]
	pub(crate) const fn type_name(&self) -> &'static str {
		self.type_name
	}

	#[must_use]
	pub(crate) const fn description(&self) -> &'static str {
		self.description
	}
}
// endregion:   --- PortDefinition