Crates.io | shive |
lib.rs | shive |
version | |
source | src |
created_at | 2024-07-15 11:37:43.859591 |
updated_at | 2024-07-15 11:37:43.859591 |
description | Shive is lightweight IOC service container writen for the Rust applications |
homepage | https://github.com/b4b4t/shive |
repository | https://github.com/b4b4t/shive |
max_upload_size | |
id | 1303703 |
size | 0 |
Shive, for service hive, is lightweight IOC service container writen for the Rust applications. This is a basic implementation of an IOC which manages the services from a container.
To use the library in your project, you can add the following line in the Cargo.toml file :
shive = { version = "0.1.0-alpha.1", features = ["derive"] }
Work in progress and this is not production ready, please proceed with caution.
A service is a struct that implements the Service
trait to be initialized by the service provider.
If the service depends on other services, these must be added in the struct properties and they must be hosted in a Arc pointer.
Example :
#[derive(Clone)]
pub struct TestService {
test_repository: Arc<TestRepository>,
}
impl Service for TestService {
fn as_any(&self) -> &dyn std::any::Any {
self
}
fn init(service_provider: &ServiceProvider) -> Arc<dyn Service>
where
Self: Sized,
{
let test_repository = ServiceManager::get_instance::<TestRepository>(service_provider)
.expect("Error to retrieve instance");
Arc::new(Self { test_repository })
}
}
By using the derive
feature, you can simplify this declaration with the Service
derive macro :
#[derive(Service, Clone)]
pub struct TestService {
test_repository: Arc<TestRepository>,
}
To create a service container, use the new
method.
Example :
let mut service_container = ServiceContainer::new();
4 lifetimes that can be declared in the service container :
service_container.add_singleton::<TestType>();
service_container.add_scoped::<TestType>();
service_container.add_transient::<TestType>();
service_container.add_unmanaged::<TestType>(TestType::new());
Service providers contain services that are scoped by its lifetime, singletons and unmanaged services.
For the transient services, they are created each time they are requested from the service provider.
To acquire a service provider from a container, you need to build the service container to get the root service provider. Then, you can get the service provider by creating a new scope from this one.
Example :
let root_service_provider = service_container.build();
let service_provider = root_provider.create_scope();
A service can be get from a service provider with the get_instance
method.
Example :
let service = service_provider.get_instance::<TestType>();