diff options
author | HampusM <hampus@hampusmat.com> | 2022-11-10 21:08:03 +0100 |
---|---|---|
committer | HampusM <hampus@hampusmat.com> | 2022-11-10 21:08:03 +0100 |
commit | ad908d2f82eb10e0f0dbc3a1b01e804b8a1ff6f9 (patch) | |
tree | e32d48d348dec869e5b84da6961f4f6ea8fe2d01 /README.md | |
parent | 83b16ad24c02ad7520c24f711171b4450581cf94 (diff) |
docs: add terminology guide to readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 16 insertions, 1 deletions
@@ -166,10 +166,25 @@ fn main() -> Result<(), Box<dyn Error>> For more examples see the [examples folder](https://git.hampusmat.com/syrette/tree/examples). +## Terminology +**Transient**<br> +A type or trait that is unique to owner. + +**Singleton**<br> +A type that only has a single instance. The opposite of transient. Generally discouraged. + +**Interface**<br> +A type or trait that represents a type (itself in the case of it being a type). + +**Factory**<br> +A function that creates new instances of a specific type or trait. + +**Default factory**<br> +A function that takes no arguments that creates new instances of a specific type or trait. + ## Rust version requirements Syrette requires Rust >= 1.62.1 to work. This is mainly due to the dependency on [Linkme](https://crates.io/crates/linkme). - ## Todo - Add support for generic factories |