Skip to main content

Blackboard

Struct Blackboard 

Source
pub struct Blackboard {
    pub entries: HashMap<String, BlackboardEntry>,
    pub current_time: f64,
}
Expand description

A typed, expiring key-value knowledge base for AI agents.

Fields§

§entries: HashMap<String, BlackboardEntry>§current_time: f64

Implementations§

Source§

impl Blackboard

Source

pub fn new() -> Self

Source

pub fn set(&mut self, key: impl Into<String>, value: impl Into<BlackboardValue>)

Store a permanent entry.

Source

pub fn set_with_ttl( &mut self, key: impl Into<String>, value: impl Into<BlackboardValue>, ttl: f64, )

Store an entry that expires after ttl seconds.

Source

pub fn get(&self, key: &str) -> Option<&BlackboardValue>

Retrieve a value if it exists and has not expired.

Source

pub fn get_entry(&self, key: &str) -> Option<&BlackboardEntry>

Retrieve the full entry (value + metadata).

Source

pub fn get_bool(&self, key: &str) -> Option<bool>

Source

pub fn get_int(&self, key: &str) -> Option<i64>

Source

pub fn get_float(&self, key: &str) -> Option<f64>

Source

pub fn get_vec2(&self, key: &str) -> Option<Vec2>

Source

pub fn get_vec3(&self, key: &str) -> Option<Vec3>

Source

pub fn get_str(&self, key: &str) -> Option<&str>

Source

pub fn get_entity(&self, key: &str) -> Option<u64>

Source

pub fn remove(&mut self, key: &str) -> Option<BlackboardValue>

Remove a key from the blackboard.

Source

pub fn update(&mut self, dt: f64)

Advance simulated time and remove all expired entries.

Source

pub fn set_time(&mut self, t: f64)

Set the current time directly (useful for tests).

Source

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

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn keys(&self) -> impl Iterator<Item = &String>

Iterate over non-expired keys.

Source

pub fn clear(&mut self)

Clear all entries.

Source

pub fn merge(&mut self, other: &Blackboard)

Merge entries from other into this blackboard. Entries in other overwrite entries in self if the key already exists.

Source

pub fn increment_int(&mut self, key: &str, delta: i64)

Increment an integer value, inserting 0 + delta if not present.

Source

pub fn increment_float(&mut self, key: &str, delta: f64)

Increment a float value.

Source

pub fn push_to_list(&mut self, key: &str, value: BlackboardValue)

Append a value to a list entry; creates the list if not present.

Source

pub fn snapshot(&self) -> Vec<(&String, &BlackboardValue)>

Returns all non-expired (key, value) pairs.

Source§

impl Blackboard

Source

pub fn debug_dump(&self) -> String

Dump all non-expired entries to a human-readable string.

Trait Implementations§

Source§

impl Clone for Blackboard

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Blackboard

Source§

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

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

impl Default for Blackboard

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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