The largest value representable as a positive Int
, which is PosInt(2147483647)
.
The largest value representable as a positive Int
, which is PosInt(2147483647)
.
The smallest value representable as a positive Int
, which is PosInt(1)
.
The smallest value representable as a positive Int
, which is PosInt(1)
.
A factory method, implemented via a macro, that produces a PosInt
if passed a valid Int
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a PosInt
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 PosInt
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.
the Int
literal expression to inspect at compile time,
and if positive, to return wrapped in a PosInt
at run time.
the specified, valid Int
literal value wrapped
in a PosInt
. (If the specified expression is not a valid
Int
literal, the invocation of this method will not
compile.)
A factory/assertion method that produces a PosInt
given a
valid Int
value, or throws AssertionError
,
if given an invalid Int
value.
A factory/assertion method that produces a PosInt
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 positive Int
, it will return a PosInt
representing that value. Otherwise, the passed Int
value is not positive, 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 positive.
the Int
to inspect, and if positive, return
wrapped in a PosInt
.
the specified Int
value wrapped
in a PosInt
, if it is positive, else throws AssertionError
.
AssertionError
if the passed value is not positive
A factory method that produces an Option[PosInt]
given an
Int
value.
A factory method that produces an Option[PosInt]
given an
Int
value.
This method will inspect the passed Int
value and if
it is a positive Int
, i.e., a positive integer value,
it will return a PosInt
representing that value,
wrapped in a Some
. Otherwise, the passed Int
value is not positive 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.
the Int
to inspect, and if positive, return
wrapped in a Some[PosInt]
.
the specified Int
value wrapped
in a Some[PosInt]
, if it is positive, else None
.
A factory method that produces a PosInt
given a
Int
value and a default PosInt
.
A factory method that produces a PosInt
given a
Int
value and a default PosInt
.
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 PosInt
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.
the Int
to inspect, and if positive, return.
the PosInt
to return if the passed
Int
value is not positive.
the specified Int
value wrapped in a
PosInt
, if it is positive, else the
default
PosInt
value.
A factory/validation method that produces a PosInt
, 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 PosInt
, 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 positive Int
, it will return a PosInt
representing that value, wrapped in a Good
.
Otherwise, the passed Int
value is not positive, 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.
the Int
to inspect, and if positive, return
wrapped in a Good(PosInt)
.
the specified Int
value wrapped
in a Good(PosInt)
, if it is positive, else a Bad(f(value))
.
A predicate method that returns true if a given
Int
value is positive.
A predicate method that returns true if a given
Int
value is positive.
the Int
to inspect, and if positive, return true.
true if the specified Int
is positive, else false.
Implicit Ordering instance.
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 positive Int
, it will return a Pass
.
Otherwise, the passed Int
value is positive, 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.
the Int
to validate that it is positive.
a Pass
if the specified Int
value is positive,
else a Fail
containing an error value produced by passing the
specified Int
to the given function f
.
A factory/validation method that produces a PosInt
, 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 PosInt
, 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 positive Int
, it will return a PosInt
representing that value, wrapped in a Right
.
Otherwise, the passed Int
value is not positive, 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.
the Int
to inspect, and if positive, return
wrapped in a Right(PosInt)
.
the specified Int
value wrapped
in a Right(PosInt)
, if it is positive, else a Left(f(value))
.
A factory/validation method that produces a PosInt
, 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 PosInt
, 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 positive Int
, it will return a PosInt
representing that value, wrapped in a Success
.
Otherwise, the passed Int
value is not positive, 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.
the Int
to inspect, and if positive, return
wrapped in a Success(PosInt)
.
the specified Int
value wrapped
in a Success(PosInt)
, if it is positive, else a Failure(AssertionError)
.
Implicit widening conversion from PosInt
to Double
.
Implicit widening conversion from PosInt
to Double
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Double
.
Implicit widening conversion from PosInt
to Float
.
Implicit widening conversion from PosInt
to Float
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Float
.
Implicit widening conversion from PosInt
to Int
.
Implicit widening conversion from PosInt
to Int
.
the PosInt
to widen
the Int
value underlying the specified PosInt
.
Implicit widening conversion from PosInt
to Long
.
Implicit widening conversion from PosInt
to Long
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Long
.
Implicit widening conversion from PosInt
to NonZeroDouble
.
Implicit widening conversion from PosInt
to NonZeroDouble
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Double
and wrapped in a NonZeroDouble
.
Implicit widening conversion from PosInt
to NonZeroFloat
.
Implicit widening conversion from PosInt
to NonZeroFloat
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Float
and wrapped in a NonZeroFloat
.
Implicit widening conversion from PosInt
to NonZeroInt
.
Implicit widening conversion from PosInt
to NonZeroInt
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Int
and wrapped in a NonZeroInt
.
Implicit widening conversion from PosInt
to NonZeroLong
.
Implicit widening conversion from PosInt
to NonZeroLong
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Long
and wrapped in a NonZeroLong
.
Implicit widening conversion from PosInt
to PosDouble
.
Implicit widening conversion from PosInt
to PosDouble
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Double
and wrapped in a PosDouble
.
Implicit widening conversion from PosInt
to PosFloat
.
Implicit widening conversion from PosInt
to PosFloat
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Float
and wrapped in a PosFloat
.
Implicit widening conversion from PosInt
to PosLong
.
Implicit widening conversion from PosInt
to PosLong
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Long
and wrapped in a PosLong
.
Implicit widening conversion from PosInt
to PosZDouble
.
Implicit widening conversion from PosInt
to PosZDouble
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Double
and wrapped in a PosZDouble
.
Implicit widening conversion from PosInt
to PosZFloat
.
Implicit widening conversion from PosInt
to PosZFloat
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Float
and wrapped in a PosZFloat
.
Implicit widening conversion from PosInt
to PosZInt
.
Implicit widening conversion from PosInt
to PosZInt
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Int
and wrapped in a PosZInt
.
Implicit widening conversion from PosInt
to PosZLong
.
Implicit widening conversion from PosInt
to PosZLong
.
the PosInt
to widen
the Int
value underlying the specified PosInt
,
widened to Long
and wrapped in a PosZLong
.
The companion object for
PosInt
that offers factory methods that producePosInt
s, implicit widening conversions fromPosInt
to other numeric types, and maximum and minimum constant values forPosInt
.