     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72

    //! RDRAND and RDSEED instructions for returning random numbers from an Intel
    //! on-chip hardware random number generator which has been seeded by an
    //! on-chip entropy source.

    extern "platform-intrinsic" {
        fn x86_rdrand16_step() -> (u16, i32);
        fn x86_rdrand32_step() -> (u32, i32);
        fn x86_rdseed16_step() -> (u16, i32);
        fn x86_rdseed32_step() -> (u32, i32);
    }

    #[cfg(test)]
    use stdsimd_test::assert_instr;

    /// Read a hardware generated 16-bit random value and store the result in val.
    /// Return 1 if a random value was generated, and 0 otherwise.
    ///
    /// [Intel's documentation](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_rdrand16_step)
    #[inline]
    #[target_feature(enable = "rdrand")]
    #[cfg_attr(test, assert_instr(rdrand))]
    #[cfg_attr(feature = "cargo-clippy", allow(stutter))]
    #[stable(feature = "simd_x86", since = "1.27.0")]
    pub unsafe fn _rdrand16_step(val: &mut u16) -> i32 {
        let (v, flag) = x86_rdrand16_step();
        *val = v;
        flag
    }

    /// Read a hardware generated 32-bit random value and store the result in val.
    /// Return 1 if a random value was generated, and 0 otherwise.
    ///
    /// [Intel's documentation](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_rdrand32_step)
    #[inline]
    #[target_feature(enable = "rdrand")]
    #[cfg_attr(test, assert_instr(rdrand))]
    #[cfg_attr(feature = "cargo-clippy", allow(stutter))]
    #[stable(feature = "simd_x86", since = "1.27.0")]
    pub unsafe fn _rdrand32_step(val: &mut u32) -> i32 {
        let (v, flag) = x86_rdrand32_step();
        *val = v;
        flag
    }

    /// Read a 16-bit NIST SP800-90B and SP800-90C compliant random value and store
    /// in val. Return 1 if a random value was generated, and 0 otherwise.
    ///
    /// [Intel's documentation](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_rdseed16_step)
    #[inline]
    #[target_feature(enable = "rdseed")]
    #[cfg_attr(test, assert_instr(rdseed))]
    #[stable(feature = "simd_x86", since = "1.27.0")]
    pub unsafe fn _rdseed16_step(val: &mut u16) -> i32 {
        let (v, flag) = x86_rdseed16_step();
        *val = v;
        flag
    }

    /// Read a 32-bit NIST SP800-90B and SP800-90C compliant random value and store
    /// in val. Return 1 if a random value was generated, and 0 otherwise.
    ///
    /// [Intel's documentation](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_rdseed32_step)
    #[inline]
    #[target_feature(enable = "rdseed")]
    #[cfg_attr(test, assert_instr(rdseed))]
    #[stable(feature = "simd_x86", since = "1.27.0")]
    pub unsafe fn _rdseed32_step(val: &mut u32) -> i32 {
        let (v, flag) = x86_rdseed32_step();
        *val = v;
        flag
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)