Uint8

Utilities for working with the Uint8 type.

1

from "uint8" include Uint8

1

1us

1

10us

Values

Functions and constants included in the Uint8 module.

Uint8.fromNumber

1

fromNumber : (number: Number) => Uint8

Converts a Number to a Uint8.

Parameters:

Returns:

Uint8.toNumber

1

toNumber : (value: Uint8) => Number

Converts a Uint8 to a Number.

Parameters:

Returns:

Uint8.fromInt8

1

fromInt8 : (number: Int8) => Uint8

Converts an Int8 to a Uint8.

Parameters:

Returns:

Examples:

1

Uint8.fromInt8(1s) == 1us

1

Uint8.fromInt8(-1s) == 255us

Uint8.incr

1

incr : (value: Uint8) => Uint8

Increments the value by one.

Parameters:

Returns:

Examples:

1

Uint8.incr(1us) == 2us

Uint8.decr

1

decr : (value: Uint8) => Uint8

Decrements the value by one.

Parameters:

Returns:

Examples:

1

Uint8.decr(1us) == 0us

1

Uint8.decr(0us) == 255us

Uint8.(+)

1

(+) : (x: Uint8, y: Uint8) => Uint8

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (+) }
assert 1us + 1us == 2us

Uint8.(-)

1

(-) : (x: Uint8, y: Uint8) => Uint8

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (-) }
assert 2us - 1us == 1us

Uint8.(*)

1

(*) : (x: Uint8, y: Uint8) => Uint8

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (*) }
assert 2us * 2us == 4us

Uint8.(/)

1

(/) : (x: Uint8, y: Uint8) => Uint8

Computes the quotient of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (/) }
assert 5us / 2us == 2us

Uint8.rem

1

rem : (x: Uint8, y: Uint8) => Uint8

Computes the remainder of the division of its operands.

Parameters:

Returns:

Examples:

1

Uint8.rem(5us, 2us) == 1us

Uint8.(<<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (<<) }
assert (5us << 1us) == 10us

Uint8.(>>>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (>>>) }
assert (5us >>> 1us) == 2us

Uint8.(==)

1

(==) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (==) }
assert 1us == 1us

Uint8.(!=)

1

(!=) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is not equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (!=) }
assert 1us != 3us

Uint8.(<)

1

(<) : (x: Uint8, y: Uint8) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (<) }
assert 1us < 5us

Uint8.(>)

1

(>) : (x: Uint8, y: Uint8) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (>) }
assert 4us > 2us

Uint8.(<=)

1

(<=) : (x: Uint8, y: Uint8) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (<=) }
assert 1us <= 2us

1
2

use Uint8.{ (<=) }
assert 1us <= 1us

Uint8.(>=)

1

(>=) : (x: Uint8, y: Uint8) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (>=) }
assert 3us >= 2us

1
2

use Uint8.{ (>=) }
assert 1us >= 1us

Uint8.lnot

1

lnot : (value: Uint8) => Uint8

Computes the bitwise NOT of the given value.

Parameters:

Returns:

Examples:

1

Uint8.lnot(5us) == 250us

Uint8.(&)

1

(&) : (x: Uint8, y: Uint8) => Uint8

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (&) }
assert (3us & 4us) == 0us

Uint8.(|)

1

(|) : (x: Uint8, y: Uint8) => Uint8

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (|) }
assert (3us | 4us) == 7us

Uint8.(^)

1

(^) : (x: Uint8, y: Uint8) => Uint8

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

Parameters:

Returns:

Examples:

1
2

use Uint8.{ (^) }
assert (3us ^ 5us) == 6us