From ad908d2f82eb10e0f0dbc3a1b01e804b8a1ff6f9 Mon Sep 17 00:00:00 2001 From: HampusM Date: Thu, 10 Nov 2022 21:08:03 +0100 Subject: docs: add terminology guide to readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3513eeb..6a40ff1 100644 --- a/README.md +++ b/README.md @@ -166,10 +166,25 @@ fn main() -> Result<(), Box> For more examples see the [examples folder](https://git.hampusmat.com/syrette/tree/examples). +## Terminology +**Transient**
+A type or trait that is unique to owner. + +**Singleton**
+A type that only has a single instance. The opposite of transient. Generally discouraged. + +**Interface**
+A type or trait that represents a type (itself in the case of it being a type). + +**Factory**
+A function that creates new instances of a specific type or trait. + +**Default factory**
+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 -- cgit v1.2.3-18-g5258