Trait Zeroable

Source

pub unsafe trait Zeroable {
    // Provided methods
    fn init_zeroed() -> impl Init<Self>
       where Self: Sized { ... }
    fn zeroed() -> Self
       where Self: Sized { ... }
}

Expand description

Marker trait for types that can be initialized by writing just zeroes.

§Safety

The bit pattern consisting of only zeroes is a valid bit pattern for this type. In other words, this is not UB:

let val: Self = unsafe { core::mem::zeroed() };

Provided Methods§

Source

fn init_zeroed() -> impl Init<Self>
where Self: Sized,

Create a new zeroed Self.

The returned initializer will write 0x00 to every byte of the given slot.

Source

fn zeroed() -> Self
where Self: Sized,

Create a Self consisting of all zeroes.

Whenever a type implements Zeroable, this function should be preferred over core::mem::zeroed() or using MaybeUninit<T>::zeroed().assume_init().

§Examples

use pin_init::{Zeroable, zeroed};

#[derive(Zeroable)]
struct Point {
    x: u32,
    y: u32,
}

let point: Point = zeroed();
assert_eq!(point.x, 0);
assert_eq!(point.y, 0);