|
|
@@ -4,7 +4,35 @@ A trait/typeclass system for Chicken Scheme, inspired by [*Type Classes Without
|
|
|
|
|
|
I prefer the name *typeclass*, but there has been an egg named typeclass already. So I borrowed the word *trait* from Rust.
|
|
|
|
|
|
-## Example
|
|
|
+Code is hosted on [SourceHut](https://git.sr.ht/~mistivia/trait).
|
|
|
+
|
|
|
+## API
|
|
|
+
|
|
|
+### define-trait
|
|
|
+
|
|
|
+ (define-trait <name>
|
|
|
+ (<func-name> [default-implementation])
|
|
|
+ ...)
|
|
|
+
|
|
|
+Define a trait. Default implementation is optional. When defined in a module, you need to export `<name>` and every `<func-name>` to use the trait.
|
|
|
+
|
|
|
+### define-trait-impl
|
|
|
+
|
|
|
+ (define-trait-impl (<trait> <type-pred>)
|
|
|
+ (<func-name> <function-impl>)
|
|
|
+ ...)
|
|
|
+
|
|
|
+Define the implementation of a trait for objects satisfying `<type-pred>`. Unimplemented functions in trait will fallback to default implementation.
|
|
|
+
|
|
|
+When calling `<func-name>`, implementations will be selected by the first argument of the function call.
|
|
|
+
|
|
|
+### with-type-of
|
|
|
+
|
|
|
+ (with-type-of <object> <trait> <func-name>)
|
|
|
+
|
|
|
+Sometimes the implementation of a function cannot be decided though the arguments, in such case, `with-type-of` can give you the implementation through specifying the object.
|
|
|
+
|
|
|
+## Examples
|
|
|
|
|
|
### Eq
|
|
|
|
|
|
@@ -157,3 +185,6 @@ I prefer the name *typeclass*, but there has been an egg named typeclass already
|
|
|
(display (/= (make-point 1 2) (make-point 1 2)))
|
|
|
(newline))
|
|
|
|
|
|
+## License
|
|
|
+
|
|
|
+This library is relaeased by BSD license.
|
