Pervasives

This module is automatically imported into every Grain program. You can think of it as the global environment. Although it is automatically imported, it can still be imported manually.

1

from "pervasives" include Pervasives

Values

Functions and constants included in the Pervasives module.

Pervasives.(!)

1

(!) : (bool: Bool) => Bool

Computes the logical NOT (!) of the given operand. Inverts the given Boolean value.

Parameters:

Returns:

Examples:

1

!true // false

1

!false // true

Pervasives.(&&)

1

(&&) : (left: Bool, right: Bool) => Bool

Computes the logical AND (&&) of the given operands.

If the first operand is false, returns false without evaluating the second operand. If the first operand is true, returns the value of the second operand.

Parameters:

Returns:

Pervasives.(||)

1

(||) : (left: Bool, right: Bool) => Bool

Computes the logical OR || of the given operands.

If the first operand is true, returns true without evaluating the second operand. If the first operand is false, returns the value of the second operand.

Parameters:

Returns:

Pervasives.(==)

1

(==) : (value1: a, value2: a) => Bool

Check that two values are equal. This checks for structural equality, so it also works for comparing things like tuples and lists.

Parameters:

Returns:

Pervasives.(!=)

1

(!=) : (value1: a, value2: a) => Bool

Check that two values are not equal. This checks for structural equality, so it also works for comparing things like tuples and lists.

Parameters:

Returns:

Pervasives.is

1

is : (left: a, right: a) => Bool

Checks that two values are physically equal. Use this operator if you don’t need or want structural equality.

Parameters:

Returns:

Pervasives.isnt

1

isnt : (value1: a, value2: a) => Bool

Checks that two values are not physically equal. Use this operator if you don’t need or want structural equality.

Parameters:

Returns:

Pervasives.(<)

1

(<) : (num1: Number, num2: Number) => Bool

Checks if the first operand is less than the second operand.

Parameters:

Returns:

Pervasives.(>)

1

(>) : (num1: Number, num2: Number) => Bool

Checks if the first operand is greater than the second operand.

Parameters:

Returns:

Pervasives.(<=)

1

(<=) : (num1: Number, num2: Number) => Bool

Checks if the first operand is less than or equal to the second operand.

Parameters:

Returns:

Pervasives.(>=)

1

(>=) : (num1: Number, num2: Number) => Bool

Checks if the first operand is greater than or equal to the second operand.

Parameters:

Returns:

Pervasives.compare

1

compare : (num1: a, num2: a) => Number

Compares the first argument to the second argument and produces an integer result. Provides a consistent ordering over all types and is suitable for sorting and other kinds of ordering. compare treats NaN differently than the other comparison operators in that it considers NaN equal to itself and smaller than any other number.

Parameters:

Returns:

Pervasives.(+)

1

(+) : (num1: Number, num2: Number) => Number

Computes the sum of its operands.

Parameters:

Returns:

Pervasives.(-)

1

(-) : (num1: Number, num2: Number) => Number

Computes the difference of its operands.

Parameters:

Returns:

Pervasives.(*)

1

(*) : (num1: Number, num2: Number) => Number

Computes the product of its operands.

Parameters:

Returns:

Pervasives.(/)

1

(/) : (num1: Number, num2: Number) => Number

Computes the quotient of its operands.

Parameters:

Returns:

Pervasives.(%)

1

(%) : (num1: Number, num2: Number) => Number

Computes the remainder of the division of the first operand by the second. The result will have the sign of the second operand.

Parameters:

Returns:

Pervasives.(**)

1

(**) : (base: Number, power: Number) => Number

Computes the exponentiation of the given base and power.

Parameters:

Returns:

Pervasives.incr

1

incr : (value: Number) => Number

Increments the value by one.

Parameters:

Returns:

Pervasives.decr

1

decr : (value: Number) => Number

Decrements the value by one.

Parameters:

Returns:

Pervasives.(++)

1

(++) : (str1: String, str2: String) => String

Concatenate two strings.

Parameters:

Returns:

Examples:

1

"Foo" ++ "Bar" == "FooBar"

Pervasives.lnot

1

lnot : (value: Number) => Number

Computes the bitwise NOT of the operand.

Parameters:

Returns:

Pervasives.(&)

1

(&) : (value1: Number, value2: Number) => Number

Computes the bitwise AND (&) on the given operands.

Parameters:

Returns:

Pervasives.(|)

1

(|) : (value1: Number, value2: Number) => Number

Computes the bitwise OR (|) on the given operands.

Parameters:

Returns:

Pervasives.(^)

1

(^) : (value1: Number, value2: Number) => Number

Computes the bitwise XOR (^) on the given operands.

Parameters:

Returns:

Pervasives.(<<)

1

(<<) : (value: Number, amount: Number) => Number

Shifts the bits of the value left by the given number of bits.

Parameters:

Returns:

Pervasives.(>>>)

1

(>>>) : (value: Number, amount: Number) => Number

Shifts the bits of the value right by the given number of bits, preserving the sign bit.

Parameters:

Returns:

Pervasives.(>>)

1

(>>) : (value: Number, amount: Number) => Number

Shifts the bits of the value right by the given number of bits.

Parameters:

Returns:

Pervasives.toString

1

toString : (value: a) => String

Converts the given operand to a string. Provides a better representation of data types if those types are provided from the module.

Parameters:

Returns:

Pervasives.print

1

print : (value: a, ?suffix: String) => Void

Prints the given operand to the console. Works for any type. Internally, calls toString on the operand, so a better representation of data type will be printed if those types are provided from the module.

Parameters:

Pervasives.ignore

1

ignore : (value: a) => Void

Accepts any value and always returns void.

Parameters:

Pervasives.assert

1

assert : (condition: Bool) => Void

Assert that the given Boolean condition is true.

Parameters:

Throws:

AssertionError

• When the condition is false

Examples:

1

assert 3 > 2

1

assert true

Pervasives.throw

1

throw : (exn: Exception) => a

Throw an exception. Currently, exceptions cannot be caught and will crash your program.

Parameters:

Returns:

Pervasives.fail

1

fail : (message: String) => a

Unconditionally throw a Failure exception with a message. Currently, Exceptions cannot be caught and will crash your program.

Parameters:

Returns:

Pervasives.identity

1

identity : (value: a) => a

Provides the operand untouched.

Parameters:

Returns:

Pervasives.box

1

box : (value: a) => Box<a>

Creates a box containing the given initial value. Values inside a box can be swapped out with the := operator. Generally, let mut expressions are preferable to using a Box.

Parameters:

Returns:

Pervasives.unbox

1

unbox : (value: Box<a>) => a

Retrieves the current value from a box.

Parameters:

Returns: