core::arch::arm::__breakpoint - Rust
Description: API documentation for the Rust `__breakpoint` fn in crate `core`.
Keywords: rust, rustlang, rust-lang, __breakpoint

# [−][src]Function core::arch::arm::__breakpoint

    pub unsafe fn __breakpoint(val: i32)

🔬 This is a nightly-only experimental API. (`stdsimd` #48556)
This is supported on ARM only.

Inserts a breakpoint instruction.

`val` is a compile-time constant integer in range `[0, 255]`.

The breakpoint instruction inserted is:

- `BKPT` when compiling as T32,
- `BRK` when compiling as A32 or A64.

# Safety

If `val` is out-of-range the behavior is undefined.

# Note

ARM's documentation defines that `__breakpoint` accepts the following values for `val`:

- `0...65535` when compiling as A32 or A64,
- `0...255` when compiling as T32.

The current implementation only accepts values in range `[0, 255]` - if the value is out-of-range the behavior is undefined.