File: verify.md

package info (click to toggle)
rust-coreutils 0.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 505,620 kB
  • sloc: ansic: 103,594; asm: 28,570; sh: 8,910; python: 5,581; makefile: 472; cpp: 97; javascript: 72
file content (23 lines) | stat: -rw-r--r-- 750 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Complete `BitOrder` Verification

This function checks some [`BitOrder`] implementation’s behavior on each of the
[`BitRegister`] types present on the target, and reports any violation of the
rules that it detects.

## Type Parameters

- `O`: The `BitOrder` implementation being tested.

## Parameters

- `verbose`: Controls whether the test should print diagnostic information to
  standard output. If this is false, then the test only prints a message on
  failure; if it is true, it emits a message for every test it executes.

## Panics

This panics when it detects a violation of the `BitOrder` rules. If it returns
normally, then the implementation is correct.

[`BitOrder`]: crate::order::BitOrder
[`BitRegister`]: crate::mem::BitRegister