+io.github.iltotore.iron.constraint
Type members Implicits
Type members
Type members Givens Extensions Implicits
Type members
Constraint: checks if the value pass both B and C. Acts like a boolean AND.
+
Constraint: checks if the value pass both B and C. Acts like a boolean AND.
+
Type Params B the first constraint's dummy
+C the second constraint's dummy
+
Represents the constraint associated to an input value and a dummy type.
Represents the constraint associated to an input value and a dummy type.
Type Params A the input type
B the constraint's dummy
-Implicits
Implicit conversion from Constrained[A, B] to its shadowed type
-
Implicit conversion from Constrained[A, B] to its shadowed type
+
Companion object
Constraint: checks if the input value equals (using Any#equals) to V.
+
Constraint: checks if the input value equals (using Any#equals) to V.
+
Note This constraint is runtime-only
+
Represents a type-level assertion failure.
+
Represents a type-level assertion failure.
Type Params A the input type
-B the constraint's dummy
-Value Params constrained the Constrained to be cast from
-Returns constrained as A
-
Implicit assertion check
+
Value Params constraint the type constraint applied to input
+input the invalid value
+
Constraint: checks if the input value doesn't pass B's constraint.
+
Constraint: checks if the input value doesn't pass B's constraint.
+
Type Params B the reversed constraint's dummy
+
Constraint: checks if the value pass B or C. Acts like a boolean OR.
+
Constraint: checks if the value pass B or C. Acts like a boolean OR.
+
Type Params B the first constraint's dummy
+C the second constraint's dummy
+
Constraint: checks if the input value strictly equals to V.
+
Constraint: checks if the input value strictly equals to V.
+
Extensions extension (a: A )
Ensure that a passes B's constraint
+
Ensure that a passes B's constraint
+
Type Params B the constraint's dummy
+Returns the value as Constrained
+See also Implicits
Type Params A the input type
B the constraint's dummy
Value Params constraint the applied type constraint
value the value passed to the assertion
Returns the value as Constrained (meaning "asserted value")
-
\ No newline at end of file
+
Note Due to a type inference bug of Scala 3, constrainedToValue was moved to the package object.
+
\ No newline at end of file
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/And.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/And.html
new file mode 100644
index 00000000..1458c599
--- /dev/null
+++ b/docs/scaladoc/api/io/github/iltotore/iron/constraint/And.html
@@ -0,0 +1,23 @@
+
And
Constraint: checks if the value pass both B and C. Acts like a boolean AND.
+
Constraint: checks if the value pass both B and C. Acts like a boolean AND.
+
Type Params B the first constraint's dummy
+C the second constraint's dummy
+Graph Supertypes
class Object
trait Matchable
class Any
\ No newline at end of file
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AndConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AndConstraint.html
new file mode 100644
index 00000000..141d5e07
--- /dev/null
+++ b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AndConstraint.html
@@ -0,0 +1,26 @@
+
AndConstraint
Graph Supertypes
class Object
trait Matchable
class Any
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint
\ No newline at end of file
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$CompileTimeOnly.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$CompileTimeOnly.html
new file mode 100644
index 00000000..30f462b9
--- /dev/null
+++ b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$CompileTimeOnly.html
@@ -0,0 +1,30 @@
+
CompileTimeOnly
Graph Supertypes
class Object
trait Matchable
class Any
Value members
Value members
Asserts the given value.
+
Asserts the given value.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint
\ No newline at end of file
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$RuntimeOnly.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$RuntimeOnly.html
new file mode 100644
index 00000000..a2edc632
--- /dev/null
+++ b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$RuntimeOnly.html
@@ -0,0 +1,30 @@
+
RuntimeOnly
Graph Supertypes
class Object
trait Matchable
class Any
Value members
Value members
Asserts the given value.
+
Asserts the given value.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint
\ No newline at end of file
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$.html
new file mode 100644
index 00000000..f3a35229
--- /dev/null
+++ b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$.html
@@ -0,0 +1,19 @@
+
Constraint
Graph Supertypes
class Object
trait Matchable
class Any
\ No newline at end of file
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint.html
index bd579ede..e61eadc1 100644
--- a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint.html
+++ b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint.html
@@ -1,16 +1,23 @@
-
Constraint
Represents the constraint associated to an input value and a dummy type.
+
Constraint
Represents the constraint associated to an input value and a dummy type.
Represents the constraint associated to an input value and a dummy type.
Type Params A the input type
B the constraint's dummy
-Graph Supertypes Known subtypes
class Object
trait Matchable
class Any
class Object
trait Matchable
class Any
Equal
Constraint: checks if the input value equals (using Any#equals) to V.
+
Constraint: checks if the input value equals (using Any#equals) to V.
+
Note This constraint is runtime-only
+
Graph Supertypes
class Object
trait Matchable
class Any
EqualConstraint
Graph Supertypes
class Object
trait Matchable
class Any
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint IllegalValueError
Represents a type-level assertion failure.
+
Represents a type-level assertion failure.
+
Type Params A the input type
+Value Params constraint the type constraint applied to input
+input the invalid value
+Graph Supertypes
trait Product
trait Equals
class Error
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Not
Constraint: checks if the input value doesn't pass B's constraint.
+
Constraint: checks if the input value doesn't pass B's constraint.
+
Type Params B the reversed constraint's dummy
+Graph Supertypes
class Object
trait Matchable
class Any
NotConstraint
Graph Supertypes
class Object
trait Matchable
class Any
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint Or
Constraint: checks if the value pass B or C. Acts like a boolean OR.
+
Constraint: checks if the value pass B or C. Acts like a boolean OR.
+
Type Params B the first constraint's dummy
+C the second constraint's dummy
+Graph Supertypes
class Object
trait Matchable
class Any
OrConstraint
Graph Supertypes
class Object
trait Matchable
class Any
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint StrictEqual
Constraint: checks if the input value strictly equals to V.
+
Constraint: checks if the input value strictly equals to V.
+
Graph Supertypes
class Object
trait Matchable
class Any
StrictEqualConstraint
Graph Supertypes
class Object
trait Matchable
class Any
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint io.github.iltotore.iron.iterable Contains
Constraint: checks if the input contains V
+
Constraint: checks if the input contains V
+
Graph Supertypes
class Object
trait Matchable
class Any
MaxSize
Constraint: checks if the input has a size lesser or equal to V
+
Constraint: checks if the input has a size lesser or equal to V
+
Graph Supertypes
class Object
trait Matchable
class Any
MinSize
Constraint: checks if the input has a size greater or equal to V
+
Constraint: checks if the input has a size greater or equal to V
+
Graph Supertypes
class Object
trait Matchable
class Any
Size
Constraint: checks if the input has a size of V
+
Constraint: checks if the input has a size of V
+
Graph Supertypes
class Object
trait Matchable
class Any
given_RuntimeOnly_A_Contains
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint given_RuntimeOnly_A_MaxSize
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint given_RuntimeOnly_A_MinSize
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint given_RuntimeOnly_A_Size
Value members
Value members
A dummy method for assert to allow non-inline calls.
+
A dummy method for assert to allow non-inline calls.
+
Value Params value the value to be checked
+Returns true if the assertion is passed, false otherwise
+Inherited from Constraint constraint
Graph Supertypes
class Object
trait Matchable
class Any
Type members Givens
Type members
Constraint: checks if the input contains V
+
Constraint: checks if the input contains V
+
Constraint: checks if the input has a size lesser or equal to V
+
Constraint: checks if the input has a size lesser or equal to V
+
Constraint: checks if the input has a size greater or equal to V
+
Constraint: checks if the input has a size greater or equal to V
+
Constraint: checks if the input has a size of V
+
Constraint: checks if the input has a size of V
+
io.github.iltotore.iron.numeric
+io.github.iltotore.iron.numeric
Main
Graph Supertypes
Graph Supertypes
An InlineOrdering instance for Number
+
NumberOrdering
An InlineOrdering instance for Number
An InlineOrdering instance for Number
Graph Supertypes
Constraint: checks if the input value is divisible by V
+
Divisible
Constraint: checks if the input value is divisible by V
Constraint: checks if the input value is divisible by V
Graph Supertypes
Graph Supertypes
Graph Supertypes
Constraint: checks if the input value is greater than V.
+
Greater
Constraint: checks if the input value is greater than V.
Constraint: checks if the input value is greater than V.
Graph Supertypes
Graph Supertypes
Graph Supertypes
Constraint: checks if the input value is greater or equal to V.
+
GreaterEqual
Constraint: checks if the input value is greater or equal to V.
Constraint: checks if the input value is greater or equal to V.
Graph Supertypes
Graph Supertypes
Graph Supertypes
Constraint: checks if the input value is less than V.
+
Less