outrun/outrun-core/lib/modulus.outrun

17 lines
374 B
Text
Raw Normal View History

2022-08-19 16:25:42 +12:00
use Any
use Option
2022-08-04 17:38:00 +12:00
```doc
# Modulus
Values which wish to implement the `%` infix operator must implement this protocol.
```
protocol Modulus, as: do
2022-08-04 17:38:00 +12:00
```doc
Divide `self` by `other`, returning an option containing the remainder
2022-08-04 17:38:00 +12:00
It is left up to the implementer to define when it should return `Some` or `None`.
```
def modulo(self: Self, other: Any): Option
2022-08-04 17:38:00 +12:00
end