NodeRegistry

Struct NodeRegistry 

Source
pub struct NodeRegistry { /* private fields */ }
Expand description

Registry for behavior node types.

The NodeRegistry provides a factory pattern for creating behavior nodes from string identifiers and JSON configuration. This enables loading behavior trees from JSON files without hardcoding node types.

§Thread Safety

The registry is thread-safe and can be shared across multiple threads using Arc. Internally it uses RwLock to allow concurrent reads while serializing writes.

§Example

use mecha10_behavior_runtime::prelude::*;
use mecha10_behavior_runtime::NodeRegistry;
use serde_json::json;


// Create a registry
let mut registry = NodeRegistry::new();

// Register a node type
registry.register("my_behavior", |config| {
    Ok(Box::new(MyBehavior))
});

// Create an instance from the registry
let node = registry.create("my_behavior", json!({})).unwrap();

Implementations§

Source§

impl NodeRegistry

Source

pub fn new() -> Self

Create a new empty node registry.

Source

pub fn register<F>(&mut self, node_type: impl Into<String>, factory: F)
where F: Fn(Value) -> Result<BoxedBehavior> + Send + Sync + 'static,

Register a node type with a factory function.

The factory function will be called each time a node of this type is created. It receives the JSON configuration and should return a boxed behavior node.

§Arguments
  • node_type - String identifier for this node type (e.g., “move_to_goal”)
  • factory - Function that creates instances of this node type
§Example
use mecha10_behavior_runtime::NodeRegistry;
use serde_json::json;


let mut registry = NodeRegistry::new();

registry.register("move", |config| {
    let speed = config.get("speed")
        .and_then(|v| v.as_f64())
        .unwrap_or(1.0);
    Ok(Box::new(MoveBehavior { speed }))
});
Source

pub fn create(&self, node_type: &str, config: Value) -> Result<BoxedBehavior>

Create a node instance from a registered type.

This looks up the factory function for the given node type and calls it with the provided configuration to create a new instance.

§Arguments
  • node_type - The type identifier that was used during registration
  • config - JSON configuration to pass to the factory function
§Returns

A boxed behavior node instance, or an error if:

  • The node type is not registered
  • The factory function returns an error
§Example
use mecha10_behavior_runtime::NodeRegistry;
use serde_json::json;


let config = json!({ "speed": 2.0 });
let node = registry.create("move", config).unwrap();
Source

pub fn has_node(&self, node_type: &str) -> bool

Check if a node type is registered.

§Arguments
  • node_type - The type identifier to check
§Returns

true if the node type is registered, false otherwise

§Example
use mecha10_behavior_runtime::NodeRegistry;

let mut registry = NodeRegistry::new();
registry.register("move", |_| Ok(Box::new(mecha10_behavior_runtime::SequenceNode::new(vec![]))));

assert!(registry.has_node("move"));
assert!(!registry.has_node("unknown"));
Source

pub fn contains(&self, node_type: &str) -> bool

Check if a node type is registered.

§Example
use mecha10_behavior_runtime::NodeRegistry;

let mut registry = NodeRegistry::new();
registry.register("move", |_| Ok(Box::new(mecha10_behavior_runtime::SequenceNode::new(vec![]))));

assert!(registry.contains("move"));
assert!(!registry.contains("unknown"));
Source

pub fn registered_types(&self) -> Vec<String>

Get a list of all registered node types.

§Example
use mecha10_behavior_runtime::NodeRegistry;

let mut registry = NodeRegistry::new();
registry.register("move", |_| Ok(Box::new(mecha10_behavior_runtime::SequenceNode::new(vec![]))));
registry.register("rotate", |_| Ok(Box::new(mecha10_behavior_runtime::SequenceNode::new(vec![]))));

let types = registry.registered_types();
assert!(types.contains(&"move".to_string()));
assert!(types.contains(&"rotate".to_string()));
Source

pub fn len(&self) -> usize

Get the number of registered node types.

§Example
use mecha10_behavior_runtime::NodeRegistry;

let mut registry = NodeRegistry::new();
assert_eq!(registry.len(), 0);

registry.register("move", |_| Ok(Box::new(mecha10_behavior_runtime::SequenceNode::new(vec![]))));
assert_eq!(registry.len(), 1);
Source

pub fn is_empty(&self) -> bool

Check if the registry is empty.

§Example
use mecha10_behavior_runtime::NodeRegistry;

let registry = NodeRegistry::new();
assert!(registry.is_empty());

Trait Implementations§

Source§

impl Clone for NodeRegistry

Source§

fn clone(&self) -> NodeRegistry

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeRegistry

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for NodeRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more