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

PosInt

org.scalactic.anyvals.PosInt
See thePosInt companion class
object PosInt

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

Attributes

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

Members list

Value members

Concrete methods

def ensuringValid(value: Int): PosInt

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.

Value parameters

value

the Int to inspect, and if positive, return wrapped in a PosInt.

Attributes

Returns

the specified Int value wrapped in a PosInt, if it is positive, else throws AssertionError.

Throws
AssertionError

if the passed value is not positive

Source
PosInt.scala
def from(value: Int): Option[PosInt]

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.

Value parameters

value

the Int to inspect, and if positive, return wrapped in a Some[PosInt].

Attributes

Returns

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

Source
PosInt.scala
def fromOrElse(value: Int, default: => PosInt): PosInt

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.

Value parameters

default

the PosInt to return if the passed Int value is not positive.

value

the Int to inspect, and if positive, return.

Attributes

Returns

the specified Int value wrapped in a PosInt, if it is positive, else the default PosInt value.

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

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.

Value parameters

value

the Int to inspect, and if positive, return wrapped in a Good(PosInt).

Attributes

Returns

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

Source
PosInt.scala
def isValid(value: Int): Boolean

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.

Value parameters

value

the Int to inspect, and if positive, return true.

Attributes

Returns

true if the specified Int is positive, else false.

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

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.

Value parameters

value

the Int to validate that it is positive.

Attributes

Returns

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.

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

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.

Value parameters

value

the Int to inspect, and if positive, return wrapped in a Right(PosInt).

Attributes

Returns

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

Source
PosInt.scala
def tryingValid(value: Int): Try[PosInt]

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.

Value parameters

value

the Int to inspect, and if positive, return wrapped in a Success(PosInt).

Attributes

Returns

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

Source
PosInt.scala

Concrete fields

final val MaxValue: PosInt

The largest value representable as a positive Int, which is PosInt(2147483647).

The largest value representable as a positive Int, which is PosInt(2147483647).

Attributes

Source
PosInt.scala
final val MinValue: PosInt

The smallest value representable as a positive Int, which is PosInt(1).

The smallest value representable as a positive Int, which is PosInt(1).

Attributes

Source
PosInt.scala

Deprecated fields

val posIntOrd: Ordering[PosInt]

The formerly implicit posIntOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

The formerly implicit posIntOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

Attributes

Deprecated
true
Source
PosInt.scala

Implicits

Implicits

implicit inline def apply(value: => Int): PosInt

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.

Value parameters

value

the Int literal expression to inspect at compile time, and if positive, to return wrapped in a PosInt at run time.

Attributes

Returns

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.)

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

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

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

Implicit widening conversion from PosInt to Double.

Implicit widening conversion from PosInt to Double.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Double.

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

Implicit widening conversion from PosInt to Float.

Implicit widening conversion from PosInt to Float.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Float.

Source
PosInt.scala
implicit def widenToInt(pos: PosInt): Int

Implicit widening conversion from PosInt to Int.

Implicit widening conversion from PosInt to Int.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt.

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

Implicit widening conversion from PosInt to Long.

Implicit widening conversion from PosInt to Long.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Long.

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

Implicit widening conversion from PosInt to NonZeroDouble.

Implicit widening conversion from PosInt to NonZeroDouble.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Double and wrapped in a NonZeroDouble.

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

Implicit widening conversion from PosInt to NonZeroFloat.

Implicit widening conversion from PosInt to NonZeroFloat.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Float and wrapped in a NonZeroFloat.

Source
PosInt.scala
implicit def widenToNonZeroInt(pos: PosInt): NonZeroInt

Implicit widening conversion from PosInt to NonZeroInt.

Implicit widening conversion from PosInt to NonZeroInt.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Int and wrapped in a NonZeroInt.

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

Implicit widening conversion from PosInt to NonZeroLong.

Implicit widening conversion from PosInt to NonZeroLong.

Value parameters

pos

the PosInt to widen

Attributes

Returns

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

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

Implicit widening conversion from PosInt to PosDouble.

Implicit widening conversion from PosInt to PosDouble.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Double and wrapped in a PosDouble.

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

Implicit widening conversion from PosInt to PosFloat.

Implicit widening conversion from PosInt to PosFloat.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Float and wrapped in a PosFloat.

Source
PosInt.scala
implicit def widenToPosLong(pos: PosInt): PosLong

Implicit widening conversion from PosInt to PosLong.

Implicit widening conversion from PosInt to PosLong.

Value parameters

pos

the PosInt to widen

Attributes

Returns

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

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

Implicit widening conversion from PosInt to PosZDouble.

Implicit widening conversion from PosInt to PosZDouble.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Double and wrapped in a PosZDouble.

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

Implicit widening conversion from PosInt to PosZFloat.

Implicit widening conversion from PosInt to PosZFloat.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Float and wrapped in a PosZFloat.

Source
PosInt.scala
implicit def widenToPosZInt(pos: PosInt): PosZInt

Implicit widening conversion from PosInt to PosZInt.

Implicit widening conversion from PosInt to PosZInt.

Value parameters

pos

the PosInt to widen

Attributes

Returns

the Int value underlying the specified PosInt, widened to Int and wrapped in a PosZInt.

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

Implicit widening conversion from PosInt to PosZLong.

Implicit widening conversion from PosInt to PosZLong.

Value parameters

pos

the PosInt to widen

Attributes

Returns

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

Source
PosInt.scala
Generated with