The companion object for NegInt that offers factory methods that
produce NegInts, implicit widening conversions from NegInt
to other numeric types, and maximum and minimum constant values for NegInt.
- Companion:
- class
- Source:
- NegInt.scala
Value members
Concrete methods
A factory/assertion method that produces a NegInt given a
valid Int value, or throws AssertionError,
if given an invalid Int value.
A factory/assertion method that produces a NegInt given a
valid Int value, or throws AssertionError,
if given an invalid Int value.
Note: you should use this method only when you are convinced that it will
always succeed, i.e., never throw an exception. It is good practice to
add a comment near the invocation of this method indicating ''why'' you think
it will always succeed to document your reasoning. If you are not sure an
ensuringValid call will always succeed, you should use one of the other
factory or validation methods provided on this object instead: isValid,
tryingValid, passOrElse, goodOrElse, or rightOrElse.
This method will inspect the passed Int value and if
it is a negative Int, it will return a NegInt
representing that value. Otherwise, the passed Int value is not negative, so this
method will throw AssertionError.
This factory method differs from the apply factory method
in that apply is implemented via a macro that inspects
Int literals at compile time, whereas this method inspects
Int values at run time.
It differs from a vanilla assert or ensuring
call in that you get something you didn't already have if the assertion
succeeds: a type that promises an Int is negative.
- Value parameters:
- value
the
Intto inspect, and if negative, return wrapped in aNegInt.
- Returns:
the specified
Intvalue wrapped in aNegInt, if it is negative, else throwsAssertionError.- Throws:
- AssertionError
if the passed value is not negative
- Source:
- NegInt.scala
A factory method that produces an Option[NegInt] given an
Int value.
A factory method that produces an Option[NegInt] given an
Int value.
This method will inspect the passed Int value and if
it is a negative Int, i.e., a negative integer value,
it will return a NegInt representing that value,
wrapped in a Some. Otherwise, the passed Int
value is not negative integer value, so this method will return None.
This factory method differs from the apply factory method
in that apply is implemented via a macro that inspects
Int literals at compile time, whereas from inspects
Int values at run time.
- Value parameters:
- value
the
Intto inspect, and if negative, return wrapped in aSome[NegInt].
- Returns:
the specified
Intvalue wrapped in aSome[NegInt], if it is negative, elseNone.- Source:
- NegInt.scala
A factory method that produces a NegInt given a
Int value and a default NegInt.
A factory method that produces a NegInt given a
Int value and a default NegInt.
This method will inspect the passed Int value and if
it is a positive Int, i.e., a value greater
than 0.0, it will return a NegInt representing that value.
Otherwise, the passed Int value is 0 or negative, so this
method will return the passed default value.
This factory method differs from the apply
factory method in that apply is implemented
via a macro that inspects Int literals at
compile time, whereas from inspects
Int values at run time.
- Value parameters:
- default
the
NegIntto return if the passedIntvalue is not positive.- value
the
Intto inspect, and if positive, return.
- Returns:
the specified
Intvalue wrapped in aNegInt, if it is positive, else thedefaultNegIntvalue.- Source:
- NegInt.scala
A factory/validation method that produces a NegInt, wrapped
in a Good, given a valid Int value, or if the
given Int is invalid, an error value of type B
produced by passing the given invalid Int value
to the given function f, wrapped in a Bad.
A factory/validation method that produces a NegInt, wrapped
in a Good, given a valid Int value, or if the
given Int is invalid, an error value of type B
produced by passing the given invalid Int value
to the given function f, wrapped in a Bad.
This method will inspect the passed Int value and if
it is a negative Int, it will return a NegInt
representing that value, wrapped in a Good.
Otherwise, the passed Int value is not negative, so this
method will return a result of type B obtained by passing
the invalid Int value to the given function f,
wrapped in a Bad.
This factory method differs from the apply factory method
in that apply is implemented via a macro that inspects
Int literals at compile time, whereas this method inspects
Int values at run time.
- Value parameters:
- value
the
Intto inspect, and if negative, return wrapped in aGood(NegInt).
- Returns:
the specified
Intvalue wrapped in aGood(NegInt), if it is negative, else aBad(f(value)).- Source:
- NegInt.scala
A predicate method that returns true if a given
Int value is negative.
A predicate method that returns true if a given
Int value is negative.
- Value parameters:
- value
the
Intto inspect, and if negative, return true.
- Returns:
true if the specified
Intis negative, else false.- Source:
- NegInt.scala
A validation method that produces a Pass
given a valid Int value, or
an error value of type E produced by passing the
given invalid Int value
to the given function f, wrapped in a Fail.
A validation method that produces a Pass
given a valid Int value, or
an error value of type E produced by passing the
given invalid Int value
to the given function f, wrapped in a Fail.
This method will inspect the passed Int value and if
it is a negative Int, it will return a Pass.
Otherwise, the passed Int value is negative, so this
method will return a result of type E obtained by passing
the invalid Int value to the given function f,
wrapped in a Fail.
This factory method differs from the apply factory method
in that apply is implemented via a macro that inspects
Int literals at compile time, whereas this method inspects
Int values at run time.
- Value parameters:
- value
the
Intto validate that it is negative.
- Returns:
a
Passif the specifiedIntvalue is negative, else aFailcontaining an error value produced by passing the specifiedIntto the given functionf.- Source:
- NegInt.scala
A factory/validation method that produces a NegInt, wrapped
in a Right, given a valid Int value, or if the
given Int is invalid, an error value of type L
produced by passing the given invalid Int value
to the given function f, wrapped in a Left.
A factory/validation method that produces a NegInt, wrapped
in a Right, given a valid Int value, or if the
given Int is invalid, an error value of type L
produced by passing the given invalid Int value
to the given function f, wrapped in a Left.
This method will inspect the passed Int value and if
it is a negative Int, it will return a NegInt
representing that value, wrapped in a Right.
Otherwise, the passed Int value is not negative, so this
method will return a result of type L obtained by passing
the invalid Int value to the given function f,
wrapped in a Left.
This factory method differs from the apply factory method
in that apply is implemented via a macro that inspects
Int literals at compile time, whereas this method inspects
Int values at run time.
- Value parameters:
- value
the
Intto inspect, and if negative, return wrapped in aRight(NegInt).
- Returns:
the specified
Intvalue wrapped in aRight(NegInt), if it is negative, else aLeft(f(value)).- Source:
- NegInt.scala
A factory/validation method that produces a NegInt, wrapped
in a Success, given a valid Int value, or if the
given Int is invalid, an AssertionError, wrapped
in a Failure.
A factory/validation method that produces a NegInt, wrapped
in a Success, given a valid Int value, or if the
given Int is invalid, an AssertionError, wrapped
in a Failure.
This method will inspect the passed Int value and if
it is a negative Int, it will return a NegInt
representing that value, wrapped in a Success.
Otherwise, the passed Int value is not negative, so this
method will return an AssertionError, wrapped in a Failure.
This factory method differs from the apply factory method
in that apply is implemented via a macro that inspects
Int literals at compile time, whereas this method inspects
Int values at run time.
- Value parameters:
- value
the
Intto inspect, and if negative, return wrapped in aSuccess(NegInt).
- Returns:
the specified
Intvalue wrapped in aSuccess(NegInt), if it is negative, else aFailure(AssertionError).- Source:
- NegInt.scala
Concrete fields
The largest value representable as a negative Int, which is NegInt(-1).
The largest value representable as a negative Int, which is NegInt(-1).
- Source:
- NegInt.scala
The smallest value representable as a negative Int, which is NegInt(-2147483648).
The smallest value representable as a negative Int, which is NegInt(-2147483648).
- Source:
- NegInt.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a NegInt
if passed a valid Int literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a NegInt
if passed a valid Int literal, otherwise a compile time error.
The macro that implements this method will inspect the specified Int
expression at compile time. If
the expression is a positive Int literal, i.e., with a
value greater than 0, it will return a NegInt representing that value.
Otherwise, the passed Int
expression is either a literal that is 0 or negative, or is not a literal, so
this method will give a compiler error.
This factory method differs from the from factory method
in that this method is implemented via a macro that inspects
Int literals at compile time, whereas from inspects
Int values at run time.
- Value parameters:
- value
the
Intliteral expression to inspect at compile time, and if positive, to return wrapped in aNegIntat run time.
- Returns:
the specified, valid
Intliteral value wrapped in aNegInt. (If the specified expression is not a validIntliteral, the invocation of this method will not compile.)- Source:
- NegInt.scala
Implicit widening conversion from NegInt to Double.
Implicit widening conversion from NegInt to Double.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toDouble.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to Float.
Implicit widening conversion from NegInt to Float.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toFloat.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to Int.
Implicit widening conversion from NegInt to Int.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to Long.
Implicit widening conversion from NegInt to Long.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toLong.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NegDouble.
Implicit widening conversion from NegInt to NegDouble.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toDoubleand wrapped in aNegDouble.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NegFloat.
Implicit widening conversion from NegInt to NegFloat.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toFloatand wrapped in aNegFloat.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NegLong.
Implicit widening conversion from NegInt to NegLong.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toLongand wrapped in aNegLong.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NegZDouble.
Implicit widening conversion from NegInt to NegZDouble.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toDoubleand wrapped in aNegZDouble.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NegZFloat.
Implicit widening conversion from NegInt to NegZFloat.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toFloatand wrapped in aNegZFloat.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NegZInt.
Implicit widening conversion from NegInt to NegZInt.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toIntand wrapped in aNegZInt.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NegZLong.
Implicit widening conversion from NegInt to NegZLong.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toLongand wrapped in aNegZLong.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NonZeroDouble.
Implicit widening conversion from NegInt to NonZeroDouble.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toDoubleand wrapped in aNonZeroDouble.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NonZeroFloat.
Implicit widening conversion from NegInt to NonZeroFloat.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toFloatand wrapped in aNonZeroFloat.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NonZeroInt.
Implicit widening conversion from NegInt to NonZeroInt.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toIntand wrapped in aNonZeroInt.- Source:
- NegInt.scala
Implicit widening conversion from NegInt to NonZeroLong.
Implicit widening conversion from NegInt to NonZeroLong.
- Value parameters:
- pos
the
NegIntto widen
- Returns:
the
Intvalue underlying the specifiedNegInt, widened toLongand wrapped in aNonZeroLong.- Source:
- NegInt.scala