Pudu programming language
Menu
API reference

Std.BiMap.insertChecked

1 declaration

fn

insertChecked: &Std.BiMap.BiMap[L, R] -> L -> R -> Option[Std.BiMap.BiMap[L, R]]

This is a callable function.

What it does

The map with a pair added, or None when either side is already paired.

For callers building a map that is supposed to be a bijection already — a

table of unique codes, a registry of names — where a collision means the

input was wrong rather than that the caller meant to replace something.

insert silently displaces; this reports.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • & borrows a value for this call instead of moving or copying it.
  • Names inside [ ] are type arguments, such as the item type held by a collection.
  • Option holds Some(value) or None when no value is available.

Back to Std.BiMapSearch related declarations