Scalactic 3.3.0-alpha.1
API
Generated with
Scalactic 3.3.0-alpha.1/org.scalactic/org.scalactic.anyvals/PosLong

PosLong

org.scalactic.anyvals.PosLong
See thePosLong companion class
object PosLong

The companion object for PosLong that offers factory methods that produce PosLongs, implicit widening conversions from PosLong to other numeric types, and maximum and minimum constant values for PosLong.

Attributes

Companion
class
Source
PosLong.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
PosLong.type

Members list

Value members

Concrete methods

def ensuringValid(value: Long): PosLong

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 a PosLong.

Attributes

Returns

the specified Long value wrapped in a PosLong, if it is positive, else throws AssertionError.

Throws
AssertionError

if the passed value is not positive

Source
PosLong.scala
def from(value: Long): Option[PosLong]

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 a Some[PosLong].

Attributes

Returns

the specified Long value wrapped in a Some[PosLong], if it is positive, else None.

Source
PosLong.scala
def fromOrElse(value: Long, default: => PosLong): PosLong

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 passed Long value is not positive.

value

the Long to inspect, and if positive, return.

Attributes

Returns

the specified Long value wrapped in a PosLong, if it is positive, else the default PosLong value.

Source
PosLong.scala
def goodOrElse[B](value: Long)(f: Long => B): Or[PosLong, B]

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 a Good(PosLong).

Attributes

Returns

the specified Long value wrapped in a Good(PosLong), if it is positive, else a Bad(f(value)).

Source
PosLong.scala
def isValid(value: Long): Boolean

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.

Attributes

Returns

true if the specified Long is positive, else false.

Source
PosLong.scala
def passOrElse[E](value: Long)(f: Long => E): Validation[E]

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.

Attributes

Returns

a Pass if the specified Long value is positive, else a Fail containing an error value produced by passing the specified Long to the given function f.

Source
PosLong.scala
def rightOrElse[L](value: Long)(f: Long => L): Either[L, PosLong]

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 a Right(PosLong).

Attributes

Returns

the specified Int value wrapped in a Right(PosLong), if it is positive, else a Left(f(value)).

Source
PosLong.scala
def tryingValid(value: Long): Try[PosLong]

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 a Success(PosLong).

Attributes

Returns

the specified Long value wrapped in a Success(PosLong), if it is positive, else a Failure(AssertionError).

Source
PosLong.scala

Concrete fields

final val MaxValue: PosLong

The largest value representable as a positive Long, which is PosLong(9223372036854775807).

The largest value representable as a positive Long, which is PosLong(9223372036854775807).

Attributes

Source
PosLong.scala
final val MinValue: PosLong

The smallest value representable as a positive Long, which is PosLong(1L).

The smallest value representable as a positive Long, which is PosLong(1L).

Attributes

Source
PosLong.scala

Deprecated fields

val posLongOrd: Ordering[PosLong]

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.

Attributes

Deprecated
true
Source
PosLong.scala

Implicits

Implicits

implicit inline def apply(value: => Long): PosLong

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 a PosLong at run time.

Attributes

Returns

the specified, valid Long literal value wrapped in a PosLong. (If the specified expression is not a valid Long literal, the invocation of this method will not compile.)

Source
PosLong.scala
implicit val ordering: Ordering[PosLong]

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

Source
PosLong.scala
implicit def widenToDouble(pos: PosLong): Double

Implicit widening conversion from PosLong to Double.

Implicit widening conversion from PosLong to Double.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Double.

Source
PosLong.scala
implicit def widenToFloat(pos: PosLong): Float

Implicit widening conversion from PosLong to Float.

Implicit widening conversion from PosLong to Float.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Float.

Source
PosLong.scala
implicit def widenToLong(pos: PosLong): Long

Implicit widening conversion from PosLong to Long.

Implicit widening conversion from PosLong to Long.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong.

Source
PosLong.scala
implicit def widenToNonZeroDouble(pos: PosLong): NonZeroDouble

Implicit widening conversion from PosLong to NonZeroDouble.

Implicit widening conversion from PosLong to NonZeroDouble.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Double and wrapped in a NonZeroDouble.

Source
PosLong.scala
implicit def widenToNonZeroFloat(pos: PosLong): NonZeroFloat

Implicit widening conversion from PosLong to NonZeroFloat.

Implicit widening conversion from PosLong to NonZeroFloat.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Float and wrapped in a NonZeroFloat.

Source
PosLong.scala
implicit def widenToNonZeroLong(pos: PosLong): NonZeroLong

Implicit widening conversion from PosLong to NonZeroLong.

Implicit widening conversion from PosLong to NonZeroLong.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Long and wrapped in a NonZeroLong.

Source
PosLong.scala
implicit def widenToPosDouble(pos: PosLong): PosDouble

Implicit widening conversion from PosLong to PosDouble.

Implicit widening conversion from PosLong to PosDouble.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Double and wrapped in a PosDouble.

Source
PosLong.scala
implicit def widenToPosFloat(pos: PosLong): PosFloat

Implicit widening conversion from PosLong to PosFloat.

Implicit widening conversion from PosLong to PosFloat.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Float and wrapped in a PosFloat.

Source
PosLong.scala
implicit def widenToPosZDouble(pos: PosLong): PosZDouble

Implicit widening conversion from PosLong to PosZDouble.

Implicit widening conversion from PosLong to PosZDouble.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Double and wrapped in a PosZDouble.

Source
PosLong.scala
implicit def widenToPosZFloat(pos: PosLong): PosZFloat

Implicit widening conversion from PosLong to PosZFloat.

Implicit widening conversion from PosLong to PosZFloat.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Float and wrapped in a PosZFloat.

Source
PosLong.scala
implicit def widenToPosZLong(pos: PosLong): PosZLong

Implicit widening conversion from PosLong to PosZLong.

Implicit widening conversion from PosLong to PosZLong.

Value parameters

pos

the PosLong to widen

Attributes

Returns

the Long value underlying the specified PosLong, widened to Long and wrapped in a PosZLong.

Source
PosLong.scala
Generated with