silk/u16

Profiles: aarch64-apple-darwin, aarch64-unknown-linux-gnu, aarch64-unknown-linux-gnu-no-libc, wasm32-unknown-unknown, x86_64-unknown-linux-gnu, x86_64-unknown-linux-gnu-no-libc.

Sixteen-bit unsigned integers with explicit arithmetic and conversion failure policies.

When to use

Use u16 when a file format, protocol, or compact data structure specifies exactly sixteen unsigned bits. Use usize for in-memory lengths and indices that follow the target.

Details

Ordinary arithmetic, narrowing conversions, division by zero, and invalid shift counts trap. checked* reports invalid arithmetic with Option, wrapping* computes modulo 2^16, and saturating* clamps at MIN or MAX. Right shift inserts zero bits.

Decimal parse consumes the entire input and distinguishes malformed text from range overflow. Use Format with Format.display for defaults or Format.displayWith for explicit options. Both operations stream through a mutable Writer without Allocator.

Examples

Recover from a narrowing conversion

import silk.option { Option }

import silk.u16

import silk.u8

pub fn main() -> i32 {
  let narrowed = u16.checkedToU8(300)
  let value = move narrowed
    |> Option.unwrapOr<u8>(42)
  return u8.toI32(value)
}

Import as u16 with import silk.u16.

Public declarations: 56.

MAX

pub const MAX: u16

The largest u16 value.

MIN

pub const MIN: u16

The smallest u16 value.

BITS

pub const BITS: u32

The fixed width of u16, in bits.

toU8

pub fn toU8(value: u16) -> u8

Converts value to u8. Traps if value is outside the u8 range. Use this function when an out-of-range value is a program error.

checkedToU8

pub fn checkedToU8(value: u16) -> silk/option.Option<u8>

Converts value to u8, or returns None if value is outside the u8 range. Use this function when an out-of-range value is input data.

toU16

pub fn toU16(value: u16) -> u16

Returns value unchanged as u16. Use this function when generic conversion code can select u16 as both source and destination.

checkedToU16

pub fn checkedToU16(value: u16) -> silk/option.Option<u16>

Returns Some with value unchanged as u16. Use this function when generic checked-conversion code can select the same source and destination type.

toU32

pub fn toU32(value: u16) -> u32

Converts value exactly to u32. Every u16 value is representable.

checkedToU32

pub fn checkedToU32(value: u16) -> silk/option.Option<u32>

Converts value exactly to u32 and returns Some. Every u16 value is representable.

toU64

pub fn toU64(value: u16) -> u64

Converts value exactly to u64. Every u16 value is representable.

checkedToU64

pub fn checkedToU64(value: u16) -> silk/option.Option<u64>

Converts value exactly to u64 and returns Some. Every u16 value is representable.

toUsize

pub fn toUsize(value: u16) -> usize

Converts value exactly to usize. Every u16 value is representable.

checkedToUsize

pub fn checkedToUsize(value: u16) -> silk/option.Option<usize>

Converts value exactly to usize and returns Some. Every u16 value is representable.

toI8

pub fn toI8(value: u16) -> i8

Converts value to i8. Traps if value is outside the i8 range. Use this function when an out-of-range value is a program error.

checkedToI8

pub fn checkedToI8(value: u16) -> silk/option.Option<i8>

Converts value to i8, or returns None if value is outside the i8 range. Use this function when an out-of-range value is input data.

toI16

pub fn toI16(value: u16) -> i16

Converts value to i16. Traps if value is outside the i16 range. Use this function when an out-of-range value is a program error.

checkedToI16

pub fn checkedToI16(value: u16) -> silk/option.Option<i16>

Converts value to i16, or returns None if value is outside the i16 range. Use this function when an out-of-range value is input data.

toI32

pub fn toI32(value: u16) -> i32

Converts value exactly to i32. Every u16 value is representable.

checkedToI32

pub fn checkedToI32(value: u16) -> silk/option.Option<i32>

Converts value exactly to i32 and returns Some. Every u16 value is representable.

toI64

pub fn toI64(value: u16) -> i64

Converts value exactly to i64. Every u16 value is representable.

checkedToI64

pub fn checkedToI64(value: u16) -> silk/option.Option<i64>

Converts value exactly to i64 and returns Some. Every u16 value is representable.

toIsize

pub fn toIsize(value: u16) -> isize

Converts value exactly to isize. Every u16 value is representable.

checkedToIsize

pub fn checkedToIsize(value: u16) -> silk/option.Option<isize>

Converts value exactly to isize and returns Some. Every u16 value is representable.

toF32

pub fn toF32(value: u16) -> f32

Converts value to the nearest f32 value, with ties to even.

toF64

pub fn toF64(value: u16) -> f64

Converts value to the nearest f64 value, with ties to even.

add

pub fn add(left: u16, right: u16) -> u16

Returns left + right and traps if the result is outside the u16 range. Use this function when overflow is a program error.

subtract

pub fn subtract(left: u16, right: u16) -> u16

Returns left - right and traps if the result is outside the u16 range. Use this function when overflow is a program error.

multiply

pub fn multiply(left: u16, right: u16) -> u16

Returns left * right and traps if the result is outside the u16 range. Use this function when overflow is a program error.

divide

pub fn divide(left: u16, right: u16) -> u16

Returns left / right. Traps if right is zero. Use this function when a zero divisor is a program error.

remainder

pub fn remainder(left: u16, right: u16) -> u16

Returns the remainder of left / right. Traps if right is zero. Use this function when a zero divisor is a program error.

bitAnd

pub fn bitAnd(left: u16, right: u16) -> u16

Returns the bitwise AND of left and right.

bitOr

pub fn bitOr(left: u16, right: u16) -> u16

Returns the bitwise OR of left and right.

bitXor

pub fn bitXor(left: u16, right: u16) -> u16

Returns the bitwise exclusive OR of left and right.

bitNot

pub fn bitNot(value: u16) -> u16

Returns value with each bit inverted.

shiftLeft

pub fn shiftLeft(left: u16, right: u16) -> u16

Shifts left bits left by right positions. Traps if right is not less than BITS.

shiftRight

pub fn shiftRight(left: u16, right: u16) -> u16

Shifts left bits right by right positions and inserts zero bits. Traps if right is not less than BITS.

rotateLeft

pub fn rotateLeft(left: u16, right: u16) -> u16

Rotates the bits of left left by right positions.

rotateRight

pub fn rotateRight(left: u16, right: u16) -> u16

Rotates the bits of left right by right positions.

wrappingAdd

pub fn wrappingAdd(left: u16, right: u16) -> u16

Returns left + right, wrapped to the u16 range. Use this function for deliberate modulo arithmetic.

wrappingSubtract

pub fn wrappingSubtract(left: u16, right: u16) -> u16

Returns left - right, wrapped to the u16 range. Use this function for deliberate modulo arithmetic.

wrappingMultiply

pub fn wrappingMultiply(left: u16, right: u16) -> u16

Returns left * right, wrapped to the u16 range. Use this function for deliberate modulo arithmetic.

saturatingAdd

pub fn saturatingAdd(left: u16, right: u16) -> u16

Returns left + right, clamped to MIN or MAX. Use this function when a boundary value is the required overflow result.

saturatingSubtract

pub fn saturatingSubtract(left: u16, right: u16) -> u16

Returns left - right, clamped to MIN or MAX. Use this function when a boundary value is the required overflow result.

saturatingMultiply

pub fn saturatingMultiply(left: u16, right: u16) -> u16

Returns left * right, clamped to MIN or MAX. Use this function when a boundary value is the required overflow result.

checkedAdd

pub fn checkedAdd(left: u16, right: u16) -> silk/option.Option<u16>

Returns Some with left + right, or None if the result is outside the u16 range. Use this function when overflow is input data.

checkedSubtract

pub fn checkedSubtract(left: u16, right: u16) -> silk/option.Option<u16>

Returns Some with left - right, or None if the result is outside the u16 range. Use this function when overflow is input data.

checkedMultiply

pub fn checkedMultiply(left: u16, right: u16) -> silk/option.Option<u16>

Returns Some with left * right, or None if the result is outside the u16 range. Use this function when overflow is input data.

checkedDivide

pub fn checkedDivide(left: u16, right: u16) -> silk/option.Option<u16>

Returns Some with left / right, or None if right is zero. Use this function when a zero divisor is input data.

checkedRemainder

pub fn checkedRemainder(left: u16, right: u16) -> silk/option.Option<u16>

Returns Some with the remainder, or None if right is zero. Use this function when a zero divisor is input data.

equals

pub fn equals(left: u16, right: u16) -> bool

Returns true when left and right are equal.

notEquals

pub fn notEquals(left: u16, right: u16) -> bool

Returns true when left and right are not equal.

lessThan

pub fn lessThan(left: u16, right: u16) -> bool

Returns true when left is less than right.

lessOrEqual

pub fn lessOrEqual(left: u16, right: u16) -> bool

Returns true when left is less than or equal to right.

greaterThan

pub fn greaterThan(left: u16, right: u16) -> bool

Returns true when left is greater than right.

greaterOrEqual

pub fn greaterOrEqual(left: u16, right: u16) -> bool

Returns true when left is greater than or equal to right.

parse

pub fn parse<'life0>(text: string<'life0>) -> silk/result.Result<u16, silk/format.ParseError>

Reads the complete text as an unsigned decimal u16.

Details

A failure contains silk.format.NotANumber for empty text, a sign, a non-digit, or trailing bytes. It contains silk.format.OutOfRange if the number is outside the u16 range.