The companion object for PosLong
that offers
factory methods that produce PosLong
s, implicit
widening conversions from PosLong
to other
numeric types, and maximum and minimum constant values for
PosLong
.
- Companion:
- class
- Source:
- PosLong.scala
Value members
Concrete methods
A factory/assertion method that produces an PosLong
given a
valid Long
value, or throws AssertionError
,
if given an invalid Long
value.
A factory/assertion method that produces an PosLong
given a
valid Long
value, or throws AssertionError
,
if given an invalid Long
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 Long
value and if
it is a positive Long
, it will return a PosLong
representing that value.
Otherwise, the passed Long
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 Long
literals at
compile time, whereas from
inspects
Long
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 a Long
is positive.
- Value parameters:
- value
the
Long
to inspect, and if positive, return wrapped in aPosLong
.
- Returns:
the specified
Long
value wrapped in aPosLong
, if it is positive, else throwsAssertionError
.- Throws:
- AssertionError
if the passed value is not positive
- Source:
- PosLong.scala
A factory method that produces an Option[PosLong]
given a
Long
value.
A factory method that produces an Option[PosLong]
given a
Long
value.
This method will inspect the passed Long
value and if
it is a positive Long
, it will return a PosLong
representing that value,
wrapped in a Some
. Otherwise, the passed Long
value is not positive, 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 Long
literals at
compile time, whereas from
inspects
Long
values at run time.
- Value parameters:
- value
the
Long
to inspect, and if positive, return wrapped in aSome[PosLong]
.
- Returns:
the specified
Long
value wrapped in aSome[PosLong]
, if it is positive, elseNone
.- Source:
- PosLong.scala
A factory method that produces a PosLong
given a
Long
value and a default PosLong
.
A factory method that produces a PosLong
given a
Long
value and a default PosLong
.
This method will inspect the passed Long
value and if
it is a positive Long
, it will return a PosLong
representing that value.
Otherwise, the passed Long
value is not positive, 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 Long
literals at
compile time, whereas from
inspects
Long
values at run time.
- Value parameters:
- default
the
PosLong
to return if the passedLong
value is not positive.- value
the
Long
to inspect, and if positive, return.
- Returns:
the specified
Long
value wrapped in aPosLong
, if it is positive, else thedefault
PosLong
value.- Source:
- PosLong.scala
A factory/validation method that produces a PosLong
, wrapped
in a Good
, given a valid Long
value, or if the
given Long
is invalid, an error value of type B
produced by passing the given invalid Long
value
to the given function f
, wrapped in a Bad
.
A factory/validation method that produces a PosLong
, wrapped
in a Good
, given a valid Long
value, or if the
given Long
is invalid, an error value of type B
produced by passing the given invalid Long
value
to the given function f
, wrapped in a Bad
.
This method will inspect the passed Long
value and if
it is a positive Long
, it will return a PosLong
representing that value, wrapped in a Good
.
Otherwise, the passed Long
value is not positive, so this
method will return a result of type B
obtained by passing
the invalid Long
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
Long
literals at compile time, whereas this method inspects
Long
values at run time.
- Value parameters:
- value
the
Long
to inspect, and if positive, return wrapped in aGood(PosLong)
.
- Returns:
the specified
Long
value wrapped in aGood(PosLong)
, if it is positive, else aBad(f(value))
.- Source:
- PosLong.scala
A predicate method that returns true if a given
Long
value is positive.
A predicate method that returns true if a given
Long
value is positive.
- Value parameters:
- value
the
Long
to inspect, and if positive, return true.
- Returns:
true if the specified
Long
is positive, else false.- Source:
- PosLong.scala
A validation method that produces a Pass
given a valid Long
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 Long
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 Long
value and if
it is a positive Long
, it will return a Pass
.
Otherwise, the passed Long
value is positive, so this
method will return a result of type E
obtained by passing
the invalid Long
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
Long
literals at compile time, whereas this method inspects
Long
values at run time.
- Value parameters:
- value
the
Long
to validate that it is positive.
- Returns:
a
Pass
if the specifiedLong
value is positive, else aFail
containing an error value produced by passing the specifiedLong
to the given functionf
.- Source:
- PosLong.scala
A factory/validation method that produces a PosLong
, 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 PosLong
, 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 PosLong
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.
- Value parameters:
- value
the
Int
to inspect, and if positive, return wrapped in aRight(PosLong)
.
- Returns:
the specified
Int
value wrapped in aRight(PosLong)
, if it is positive, else aLeft(f(value))
.- Source:
- PosLong.scala
A factory/validation method that produces a PosLong
, wrapped
in a Success
, given a valid Long
value, or if the
given Long
is invalid, an AssertionError
, wrapped
in a Failure
.
A factory/validation method that produces a PosLong
, wrapped
in a Success
, given a valid Long
value, or if the
given Long
is invalid, an AssertionError
, wrapped
in a Failure
.
This method will inspect the passed Long
value and if
it is a positive Long
, it will return a PosLong
representing that value, wrapped in a Success
.
Otherwise, the passed Long
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
Long
literals at compile time, whereas this method inspects
Long
values at run time.
- Value parameters:
- value
the
Long
to inspect, and if positive, return wrapped in aSuccess(PosLong)
.
- Returns:
the specified
Long
value wrapped in aSuccess(PosLong)
, if it is positive, else aFailure(AssertionError)
.- Source:
- PosLong.scala
Concrete fields
The largest value representable as a positive
Long
, which is PosLong(9223372036854775807)
.
The largest value representable as a positive
Long
, which is PosLong(9223372036854775807)
.
- Source:
- PosLong.scala
The smallest value representable as a positive
Long
, which is PosLong(1L)
.
The smallest value representable as a positive
Long
, which is PosLong(1L)
.
- Source:
- PosLong.scala
Deprecated fields
The formerly implicit posLongOrd
field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering
field instead.
The formerly implicit posLongOrd
field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering
field instead.
- Deprecated
- Source:
- PosLong.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a
PosLong
if passed a valid Long
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
PosLong
if passed a valid Long
literal, otherwise a compile time error.
The macro that implements this method will inspect the
specified Long
expression at compile time. If
the expression is a positive Long
literal,
it will return a PosLong
representing that value.
Otherwise, the passed Long
expression is either a literal
that is not positive, 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 Long
literals at compile
time, whereas from
inspects Long
values at run time.
- Value parameters:
- value
the
Long
literal expression to inspect at compile time, and if positive, to return wrapped in aPosLong
at run time.
- Returns:
the specified, valid
Long
literal value wrapped in aPosLong
. (If the specified expression is not a validLong
literal, the invocation of this method will not compile.)- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to
Double
.
Implicit widening conversion from PosLong
to
Double
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toDouble
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to
Float
.
Implicit widening conversion from PosLong
to
Float
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toFloat
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to
Long
.
Implicit widening conversion from PosLong
to
Long
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to NonZeroDouble
.
Implicit widening conversion from PosLong
to NonZeroDouble
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toDouble
and wrapped in aNonZeroDouble
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to NonZeroFloat
.
Implicit widening conversion from PosLong
to NonZeroFloat
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toFloat
and wrapped in aNonZeroFloat
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to NonZeroLong
.
Implicit widening conversion from PosLong
to NonZeroLong
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toLong
and wrapped in aNonZeroLong
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to PosDouble
.
Implicit widening conversion from PosLong
to PosDouble
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toDouble
and wrapped in aPosDouble
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to PosFloat
.
Implicit widening conversion from PosLong
to PosFloat
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toFloat
and wrapped in aPosFloat
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to PosZDouble
.
Implicit widening conversion from PosLong
to PosZDouble
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toDouble
and wrapped in aPosZDouble
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to PosZFloat
.
Implicit widening conversion from PosLong
to PosZFloat
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toFloat
and wrapped in aPosZFloat
.- Source:
- PosLong.scala
Implicit widening conversion from PosLong
to PosZLong
.
Implicit widening conversion from PosLong
to PosZLong
.
- Value parameters:
- pos
the
PosLong
to widen
- Returns:
the
Long
value underlying the specifiedPosLong
, widened toLong
and wrapped in aPosZLong
.- Source:
- PosLong.scala