diff options
Diffstat (limited to 'syrette/src')
| -rw-r--r-- | syrette/src/di_container.rs | 161 | ||||
| -rw-r--r-- | syrette/src/injectable.rs | 29 | ||||
| -rw-r--r-- | syrette/src/lib.rs | 8 | ||||
| -rw-r--r-- | syrette/src/libs/intertrait/LICENSE-APACHE | 176 | ||||
| -rw-r--r-- | syrette/src/libs/intertrait/LICENSE-MIT | 17 | ||||
| -rw-r--r-- | syrette/src/libs/intertrait/cast_box.rs | 32 | ||||
| -rw-r--r-- | syrette/src/libs/intertrait/hasher.rs | 44 | ||||
| -rw-r--r-- | syrette/src/libs/intertrait/mod.rs | 221 | ||||
| -rw-r--r-- | syrette/src/libs/mod.rs | 3 |
9 files changed, 691 insertions, 0 deletions
diff --git a/syrette/src/di_container.rs b/syrette/src/di_container.rs new file mode 100644 index 0000000..ce0d829 --- /dev/null +++ b/syrette/src/di_container.rs @@ -0,0 +1,161 @@ +use std::any::{type_name, TypeId}; +use std::collections::HashMap; +use std::fmt; +use std::fmt::{Display, Formatter}; +use std::marker::PhantomData; +use std::rc::Rc; + +use error_stack::{Context, Report, ResultExt}; + +use crate::injectable::{Injectable, ResolveError}; +use crate::libs::intertrait::cast_box::CastBox; + +trait IInjectableTypeProvider +{ + fn provide( + &self, + di_container: &DIContainer, + ) -> error_stack::Result<Box<dyn Injectable>, ResolveError>; +} + +struct InjectableTypeProvider<InjectableType> +where + InjectableType: Injectable, +{ + _phantom_data: PhantomData<InjectableType>, +} + +impl<InjectableType> InjectableTypeProvider<InjectableType> +where + InjectableType: Injectable, +{ + fn new() -> Self + { + Self { + _phantom_data: PhantomData, + } + } +} + +impl<InjectableType> IInjectableTypeProvider for InjectableTypeProvider<InjectableType> +where + InjectableType: Injectable, +{ + fn provide( + &self, + di_container: &DIContainer, + ) -> error_stack::Result<Box<dyn Injectable>, ResolveError> + { + Ok(InjectableType::resolve(di_container)?) + } +} + +pub struct BindingBuilder<'a, InterfaceTrait> +where + InterfaceTrait: 'static + ?Sized, +{ + _di_container: &'a mut DIContainer, + _phantom_data: PhantomData<InterfaceTrait>, +} + +impl<'a, InterfaceTrait> BindingBuilder<'a, InterfaceTrait> +where + InterfaceTrait: 'static + ?Sized, +{ + fn new(di_container: &'a mut DIContainer) -> Self + { + Self { + _di_container: di_container, + _phantom_data: PhantomData, + } + } + + pub fn to<Implementation>(&mut self) + where + Implementation: Injectable, + { + let interface_typeid = TypeId::of::<InterfaceTrait>(); + + self._di_container._bindings.insert( + interface_typeid, + Rc::new(InjectableTypeProvider::<Implementation>::new()), + ); + } +} + +#[derive(Debug)] +pub struct DIContainerError; + +impl Display for DIContainerError +{ + fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result + { + fmt.write_str("A DI container error has occurred") + } +} + +impl Context for DIContainerError {} + +pub struct DIContainer +{ + _bindings: HashMap<TypeId, Rc<dyn IInjectableTypeProvider>>, +} + +impl<'a> DIContainer +{ + pub fn new() -> Self + { + Self { + _bindings: HashMap::new(), + } + } + + pub fn bind<InterfaceTrait>(&'a mut self) -> BindingBuilder<InterfaceTrait> + where + InterfaceTrait: 'static + ?Sized, + { + BindingBuilder::<InterfaceTrait>::new(self) + } + + pub fn get<InterfaceTrait>( + &self, + ) -> error_stack::Result<Box<InterfaceTrait>, DIContainerError> + where + InterfaceTrait: 'static + ?Sized, + { + let interface_typeid = TypeId::of::<InterfaceTrait>(); + + let interface_name = type_name::<InterfaceTrait>(); + + let binding = self._bindings.get(&interface_typeid).ok_or_else(|| { + Report::new(DIContainerError) + .attach_printable(format!("No binding exists for {}", interface_name)) + })?; + + let binding_injectable = binding + .provide(self) + .change_context(DIContainerError) + .attach_printable(format!( + "Failed to resolve interface {}", + interface_name + ))?; + + let interface_box_result = binding_injectable.cast::<InterfaceTrait>(); + + match interface_box_result { + Ok(interface_box) => Ok(interface_box), + Err(_) => Err(Report::new(DIContainerError).attach_printable(format!( + "Unable to cast binding for {}", + interface_name + ))), + } + } +} + +impl Default for DIContainer +{ + fn default() -> Self + { + Self::new() + } +} diff --git a/syrette/src/injectable.rs b/syrette/src/injectable.rs new file mode 100644 index 0000000..3cc0d7f --- /dev/null +++ b/syrette/src/injectable.rs @@ -0,0 +1,29 @@ +use core::fmt; +use std::fmt::{Display, Formatter}; + +use error_stack::Context; + +use crate::libs::intertrait::CastFrom; +use crate::DIContainer; + +#[derive(Debug)] +pub struct ResolveError; + +impl Display for ResolveError +{ + fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result + { + fmt.write_str("Failed to resolve injectable struct") + } +} + +impl Context for ResolveError {} + +pub trait Injectable: CastFrom +{ + fn resolve( + di_container: &DIContainer, + ) -> error_stack::Result<Box<Self>, ResolveError> + where + Self: Sized; +} diff --git a/syrette/src/lib.rs b/syrette/src/lib.rs index e69de29..5cf9f71 100644 --- a/syrette/src/lib.rs +++ b/syrette/src/lib.rs @@ -0,0 +1,8 @@ +mod di_container; + +pub use di_container::*; +pub use syrette_macros::*; + +pub mod injectable; + +pub mod libs; diff --git a/syrette/src/libs/intertrait/LICENSE-APACHE b/syrette/src/libs/intertrait/LICENSE-APACHE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/syrette/src/libs/intertrait/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/syrette/src/libs/intertrait/LICENSE-MIT b/syrette/src/libs/intertrait/LICENSE-MIT new file mode 100644 index 0000000..969d061 --- /dev/null +++ b/syrette/src/libs/intertrait/LICENSE-MIT @@ -0,0 +1,17 @@ +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/syrette/src/libs/intertrait/cast_box.rs b/syrette/src/libs/intertrait/cast_box.rs new file mode 100644 index 0000000..d4da740 --- /dev/null +++ b/syrette/src/libs/intertrait/cast_box.rs @@ -0,0 +1,32 @@ +/** + * Originally from Intertrait by CodeChain + * + * https://github.com/CodeChain-io/intertrait + * https://crates.io/crates/intertrait/0.2.2 + * + * Licensed under either of + * + * Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) + + * at your option. +*/ +use crate::libs::intertrait::{caster, CastFrom}; + +pub trait CastBox +{ + /// Casts a box to this trait into that of type `T`. If fails, returns the receiver. + fn cast<T: ?Sized + 'static>(self: Box<Self>) -> Result<Box<T>, Box<Self>>; +} + +/// A blanket implementation of `CastBox` for traits extending `CastFrom`. +impl<S: ?Sized + CastFrom> CastBox for S +{ + fn cast<T: ?Sized + 'static>(self: Box<Self>) -> Result<Box<T>, Box<Self>> + { + match caster::<T>((*self).type_id()) { + Some(caster) => Ok((caster.cast_box)(self.box_any())), + None => Err(self), + } + } +} diff --git a/syrette/src/libs/intertrait/hasher.rs b/syrette/src/libs/intertrait/hasher.rs new file mode 100644 index 0000000..1fe7739 --- /dev/null +++ b/syrette/src/libs/intertrait/hasher.rs @@ -0,0 +1,44 @@ +/** + * Originally from Intertrait by CodeChain + * + * https://github.com/CodeChain-io/intertrait + * https://crates.io/crates/intertrait/0.2.2 + * + * Licensed under either of + * + * Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) + + * at your option. +*/ +use std::convert::TryInto; +use std::hash::{BuildHasherDefault, Hasher}; +use std::mem::size_of; + +/// A simple `Hasher` implementation tuned for performance. +#[derive(Default)] +pub struct FastHasher(u64); + +/// A `BuildHasher` for `FastHasher`. +pub type BuildFastHasher = BuildHasherDefault<FastHasher>; + +impl Hasher for FastHasher +{ + fn finish(&self) -> u64 + { + self.0 + } + + fn write(&mut self, bytes: &[u8]) + { + let mut bytes = bytes; + while bytes.len() > size_of::<u64>() { + let (u64_bytes, remaining) = bytes.split_at(size_of::<u64>()); + self.0 ^= u64::from_ne_bytes(u64_bytes.try_into().unwrap()); + bytes = remaining + } + self.0 ^= bytes + .iter() + .fold(0u64, |result, b| (result << 8) | *b as u64); + } +} diff --git a/syrette/src/libs/intertrait/mod.rs b/syrette/src/libs/intertrait/mod.rs new file mode 100644 index 0000000..b07d91e --- /dev/null +++ b/syrette/src/libs/intertrait/mod.rs @@ -0,0 +1,221 @@ +/** + * Originally from Intertrait by CodeChain + * + * https://github.com/CodeChain-io/intertrait + * https://crates.io/crates/intertrait/0.2.2 + * + * Licensed under either of + * + * Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) + + * at your option. +*/ +use std::any::{Any, TypeId}; +use std::collections::HashMap; +use std::rc::Rc; +use std::sync::Arc; + +use once_cell::sync::Lazy; + +extern crate linkme; + +pub use syrette_macros::castable_to; + +mod hasher; + +use hasher::BuildFastHasher; + +pub mod cast_box; + +pub type BoxedCaster = Box<dyn Any + Send + Sync>; + +#[linkme::distributed_slice] +pub static CASTERS: [fn() -> (TypeId, BoxedCaster)] = [..]; + +static CASTER_MAP: Lazy<HashMap<(TypeId, TypeId), BoxedCaster, BuildFastHasher>> = + Lazy::new(|| { + CASTERS + .iter() + .map(|f| { + let (type_id, caster) = f(); + ((type_id, (*caster).type_id()), caster) + }) + .collect() + }); + +pub struct Caster<T: ?Sized + 'static> +{ + /// Casts an immutable reference to a trait object for `Any` to a reference + /// to a trait object for trait `T`. + pub cast_ref: fn(from: &dyn Any) -> &T, + + /// Casts a mutable reference to a trait object for `Any` to a mutable reference + /// to a trait object for trait `T`. + pub cast_mut: fn(from: &mut dyn Any) -> &mut T, + + /// Casts a `Box` holding a trait object for `Any` to another `Box` holding a trait object + /// for trait `T`. + pub cast_box: fn(from: Box<dyn Any>) -> Box<T>, + + /// Casts an `Rc` holding a trait object for `Any` to another `Rc` holding a trait object + /// for trait `T`. + pub cast_rc: fn(from: Rc<dyn Any>) -> Rc<T>, +} + +impl<T: ?Sized + 'static> Caster<T> +{ + pub fn new( + cast_ref: fn(from: &dyn Any) -> &T, + cast_mut: fn(from: &mut dyn Any) -> &mut T, + cast_box: fn(from: Box<dyn Any>) -> Box<T>, + cast_rc: fn(from: Rc<dyn Any>) -> Rc<T>, + ) -> Caster<T> + { + Caster::<T> { + cast_ref, + cast_mut, + cast_box, + cast_rc, + } + } + + pub fn new_sync( + cast_ref: fn(from: &dyn Any) -> &T, + cast_mut: fn(from: &mut dyn Any) -> &mut T, + cast_box: fn(from: Box<dyn Any>) -> Box<T>, + cast_rc: fn(from: Rc<dyn Any>) -> Rc<T>, + ) -> Caster<T> + { + Caster::<T> { + cast_ref, + cast_mut, + cast_box, + cast_rc, + } + } +} + +/// Returns a `Caster<S, T>` from a concrete type `S` to a trait `T` implemented by it. +fn caster<T: ?Sized + 'static>(type_id: TypeId) -> Option<&'static Caster<T>> +{ + CASTER_MAP + .get(&(type_id, TypeId::of::<Caster<T>>())) + .and_then(|caster| caster.downcast_ref::<Caster<T>>()) +} + +/// `CastFrom` must be extended by a trait that wants to allow for casting into another trait. +/// +/// It is used for obtaining a trait object for [`Any`] from a trait object for its sub-trait, +/// and blanket implemented for all `Sized + Any + 'static` types. +/// +/// # Examples +/// ```ignore +/// trait Source: CastFrom { +/// ... +/// } +/// ``` +pub trait CastFrom: Any + 'static +{ + /// Returns a immutable reference to `Any`, which is backed by the type implementing this trait. + fn ref_any(&self) -> &dyn Any; + + /// Returns a mutable reference to `Any`, which is backed by the type implementing this trait. + fn mut_any(&mut self) -> &mut dyn Any; + + /// Returns a `Box` of `Any`, which is backed by the type implementing this trait. + fn box_any(self: Box<Self>) -> Box<dyn Any>; + + /// Returns an `Rc` of `Any`, which is backed by the type implementing this trait. + fn rc_any(self: Rc<Self>) -> Rc<dyn Any>; +} + +pub trait CastFromSync: CastFrom + Sync + Send + 'static +{ + fn arc_any(self: Arc<Self>) -> Arc<dyn Any + Sync + Send + 'static>; +} + +impl<T: Sized + Any + 'static> CastFrom for T +{ + fn ref_any(&self) -> &dyn Any + { + self + } + + fn mut_any(&mut self) -> &mut dyn Any + { + self + } + + fn box_any(self: Box<Self>) -> Box<dyn Any> + { + self + } + + fn rc_any(self: Rc<Self>) -> Rc<dyn Any> + { + self + } +} + +impl CastFrom for dyn Any + 'static +{ + fn ref_any(&self) -> &dyn Any + { + self + } + + fn mut_any(&mut self) -> &mut dyn Any + { + self + } + + fn box_any(self: Box<Self>) -> Box<dyn Any> + { + self + } + + fn rc_any(self: Rc<Self>) -> Rc<dyn Any> + { + self + } +} + +impl<T: Sized + Sync + Send + 'static> CastFromSync for T +{ + fn arc_any(self: Arc<Self>) -> Arc<dyn Any + Sync + Send + 'static> + { + self + } +} + +impl CastFrom for dyn Any + Sync + Send + 'static +{ + fn ref_any(&self) -> &dyn Any + { + self + } + + fn mut_any(&mut self) -> &mut dyn Any + { + self + } + + fn box_any(self: Box<Self>) -> Box<dyn Any> + { + self + } + + fn rc_any(self: Rc<Self>) -> Rc<dyn Any> + { + self + } +} + +impl CastFromSync for dyn Any + Sync + Send + 'static +{ + fn arc_any(self: Arc<Self>) -> Arc<dyn Any + Sync + Send + 'static> + { + self + } +} diff --git a/syrette/src/libs/mod.rs b/syrette/src/libs/mod.rs new file mode 100644 index 0000000..8d5583d --- /dev/null +++ b/syrette/src/libs/mod.rs @@ -0,0 +1,3 @@ +pub mod intertrait; + +pub extern crate linkme; |