silk/u32

Thirty-two-bit unsigned integers for fixed-width counts, masks, and binary fields.

When to use

Use u32 when an unsigned 32-bit representation is part of the contract, including masks and encoded fields. Use usize for collection positions and allocation sizes tied to the target.

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

Decimal parse requires a complete unsigned representation and reports malformed input separately from overflow. toText allocates owned text.

Examples

Extract one byte from a fixed-width field

import silk.u32 as u32

pub fn main() -> i32 {
  let shifted = u32.shiftRight(0x00002A00, 8)
  let byte = u32.bitAnd(shifted, 0xFF)
  return u32.toI32(byte)
}

Import as u32 with import silk.u32.

Public declarations: 57.

`MAX`

pub const MAX: u32

The largest u32 value.

`MIN`

pub const MIN: u32

The smallest u32 value.

`BITS`

pub const BITS: u32

The fixed width of u32, in bits.

`toU8`

pub fn toU8(value: u32) -> 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: u32) -> 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: u32) -> u16

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

`checkedToU16`

pub fn checkedToU16(value: u32) -> Option<u16>

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

`toU32`

pub fn toU32(value: u32) -> u32

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

`checkedToU32`

pub fn checkedToU32(value: u32) -> Option<u32>

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

`toU64`

pub fn toU64(value: u32) -> u64

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

`checkedToU64`

pub fn checkedToU64(value: u32) -> Option<u64>

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

`toUsize`

pub fn toUsize(value: u32) -> usize

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

`checkedToUsize`

pub fn checkedToUsize(value: u32) -> Option<usize>

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

`toI8`

pub fn toI8(value: u32) -> 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: u32) -> 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: u32) -> 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: u32) -> 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: u32) -> i32

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

`checkedToI32`

pub fn checkedToI32(value: u32) -> Option<i32>

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

`toI64`

pub fn toI64(value: u32) -> i64

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

`checkedToI64`

pub fn checkedToI64(value: u32) -> Option<i64>

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

`toIsize`

pub fn toIsize(value: u32) -> isize

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

`checkedToIsize`

pub fn checkedToIsize(value: u32) -> Option<isize>

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

`toF32`

pub fn toF32(value: u32) -> f32

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

`toF64`

pub fn toF64(value: u32) -> f64

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

`add`

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

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

`subtract`

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

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

`multiply`

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

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

`divide`

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

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

`remainder`

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

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: u32, right: u32) -> u32

Returns the bitwise AND of left and right.

`bitOr`

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

Returns the bitwise OR of left and right.

`bitXor`

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

Returns the bitwise exclusive OR of left and right.

`bitNot`

pub fn bitNot(value: u32) -> u32

Returns value with each bit inverted.

`shiftLeft`

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

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

`shiftRight`

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

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

`rotateLeft`

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

Rotates the bits of left left by right positions.

`rotateRight`

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

Rotates the bits of left right by right positions.

`wrappingAdd`

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

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

`wrappingSubtract`

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

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

`wrappingMultiply`

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

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

`saturatingAdd`

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

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: u32, right: u32) -> u32

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: u32, right: u32) -> u32

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: u32, right: u32) -> Option<u32>

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

`checkedSubtract`

pub fn checkedSubtract(left: u32, right: u32) -> Option<u32>

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

`checkedMultiply`

pub fn checkedMultiply(left: u32, right: u32) -> Option<u32>

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

`checkedDivide`

pub fn checkedDivide(left: u32, right: u32) -> Option<u32>

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: u32, right: u32) -> Option<u32>

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: u32, right: u32) -> bool

Returns true when left and right are equal.

`notEquals`

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

Returns true when left and right are not equal.

`lessThan`

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

Returns true when left is less than right.

`lessOrEqual`

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

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

`greaterThan`

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

Returns true when left is greater than right.

`greaterOrEqual`

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

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

`toText`

pub effect fn toText(value: u32) -> String ! OutOfMemoryError ? &mut Allocator

Renders the value as base-10 text in new owned storage. Allocation uses the required Allocator and can fail with OutOfMemoryError.

`parse`

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

Reads the complete text as an unsigned decimal u32.

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 u32 range.

On this page