---
title: "saturating_mul"
url: https://una-lang.org/en/docs/std/builtin/saturating_mul/
release: v0.4.0
edition: "0.2 and later"
source: https://github.com/una-lang/una/blob/v0.4.0/docs/std/builtins.json
---

# saturating_mul

A built-in method, resolved by the type of its receiver ([`spec/14 §2`](https://una-lang.org/en/docs/spec/14-standard-library/#s2)). Edition 0.2 and later.

```una
a.saturating_mul(by: F) -> F
  where a: F, one of I8, I16, I32, I64, U8, U16, U32, U64
```

Total: the exact result clamped to the type's range (`spec/18 §5`).

## Receiver

- `F, one of I8, I16, I32, I64, U8, U16, U32, U64`: a fixed\-width integer `a`\, of one of the eight types `I8`\, `I16`\, `I32`\, `I64`\, `U8`\, `U16`\, `U32` and `U64`\; the result has its type

## Parameters

- `by`: the other operand\, of the same type

## Returns

`F`: the exact product clamped to the range of the type\: the largest value when the product is above it\, the smallest when it is below\; it never fails.

## See also

[`wrapping_mul`](https://una-lang.org/en/docs/std/builtin/wrapping_mul/)

## Example

`src/shop.una`

```una
module shop

--- Products that stop at the largest value of the type.
pub main() -> Unit
  uses @console: Console[print]
=
  let boxes: U16 = 300
  let units = boxes.saturating_mul(by: 300)
  let bottom: I8 = -128
  let flipped = bottom.saturating_mul(by: -1)
  @console.print("{units}")
  @console.print("{flipped}")
```

`una run .` prints:

```text
65535
127
```

## Specification

- [`spec/18 §5`](https://una-lang.org/en/docs/spec/18-fixed-width-integers/#s5)

Generated from una v0.4.0 ([`docs/std/builtins.json`](https://github.com/una-lang/una/blob/5fec93d88932b333feec25e589355a2cb34c37b5/docs/std/builtins.json), which is not part of the specification): built-in methods have no declaration, so una writes these signature lines and tests each against its checker. The specification governs: [`spec/14 §2`](https://una-lang.org/en/docs/spec/14-standard-library/#s2).
