ResourceManager

Struct ResourceManager 

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

Centralized manager for shared plugin resources.

The ResourceManager maintains a cache of resources that can be shared across multiple node instances. It handles lifecycle management, deduplication, and optional memory-based eviction.

Implementations§

Source§

impl ResourceManager

Source

pub fn new(policy: ResourcePolicy) -> Self

Create a new ResourceManager with the specified policy.

Source

pub async fn get_or_create<F, Fut>( &self, key: ResourceKey, factory: F, ) -> Result<Arc<dyn Resource>, ResourceError>
where F: FnOnce() -> Fut, Fut: Future<Output = Result<Arc<dyn Resource>, ResourceError>>,

Get an existing resource or create it using the provided factory.

If a resource with the given key already exists, it is returned immediately. Otherwise, the factory is called to create a new resource, which is then cached for future use.

§Arguments
  • key - Unique identifier for the resource
  • factory - Async function that creates the resource if needed
§Errors

Returns an error if the factory function fails to create the resource.

§Example
use streamkit_core::resource_manager::{
    ResourceManager, Resource, ResourcePolicy, ResourceKey, ResourceError
};
use std::sync::Arc;

struct MyModel { data: Vec<f32> }

impl Resource for MyModel {
    fn size_bytes(&self) -> usize { self.data.len() * 4 }
    fn resource_type(&self) -> &str { "ml_model" }
}

async fn example() -> Result<(), ResourceError> {
    let manager = ResourceManager::new(ResourcePolicy::default());
    let resource = manager.get_or_create(
        ResourceKey::new("my_plugin", "model_v1"),
        || async {
            Ok(Arc::new(MyModel { data: vec![0.0; 1000] }) as Arc<dyn Resource>)
        }
    ).await?;
    Ok(())
}
Source

pub async fn unload(&self, key: &ResourceKey) -> Result<(), ResourceError>

Explicitly unload a resource by key.

This removes the resource from the cache. If other node instances still hold references to the resource, it will remain in memory until they drop their references.

§Errors

Returns an error if the resource key is not found in the cache.

Source

pub async fn stats(&self) -> ResourceStats

Get statistics about currently loaded resources.

Source

pub async fn clear(&self)

Clear all cached resources.

This removes all resources from the cache. Resources that are still in use by node instances will remain in memory until dropped.

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