Struct InitMask

pub struct InitMask {
    blocks: InitMaskBlocks,
    len: Size,
}

A bitmask where each bit refers to the byte with the same index. If the bit is true, the byte is initialized. If it is false the byte is uninitialized. The actual bits are only materialized when needed, and we try to keep this data lazy as long as possible. Currently, if all the blocks have the same value, then the mask represents either a fully initialized or fully uninitialized const allocation, so we can only store that single value.

Fields

blocks: InitMaskBlocks

len: Size

Implementations

impl InitMask

pub fn new(size: Size, state: bool) -> Self

pub fn is_range_initialized(&self, range: AllocRange) -> Result<(), AllocRange>

Checks whether the range is entirely initialized.

Returns Ok(()) if it’s initialized. Otherwise returns a range of byte indexes for the first contiguous span of the uninitialized access.

pub fn set_range(&mut self, range: AllocRange, new_state: bool)

Sets a specified range to a value. If the range is out-of-bounds, the mask will grow to accommodate it entirely.

fn materialize_blocks(&mut self) -> &mut InitMaskMaterialized

Materializes this mask’s blocks when the mask is lazy.

pub fn get(&self, idx: Size) -> bool

Returns the initialization state at the specified in-bounds index.

impl InitMask

pub fn range_as_init_chunks(&self, range: AllocRange) -> InitChunkIter<'_>

Returns an iterator, yielding a range of byte indexes for each contiguous region of initialized or uninitialized bytes inside the range start..end (end-exclusive).

The iterator guarantees the following:

• Chunks are nonempty.
• Chunks are adjacent (each range’s start is equal to the previous range’s end).
• Chunks span exactly start..end (the first starts at start, the last ends at end).
• Chunks alternate between InitChunk::Init and InitChunk::Uninit.

impl InitMask

Transferring the initialization mask to other allocations.

pub fn prepare_copy(&self, range: AllocRange) -> InitCopy

Creates a run-length encoding of the initialization mask; panics if range is empty.

This is essentially a more space-efficient version of InitMask::range_as_init_chunks(...).collect::<Vec<_>>().

pub fn apply_copy(&mut self, defined: InitCopy, range: AllocRange, repeat: u64)

Applies multiple instances of the run-length encoding to the initialization mask.

Trait Implementations

impl Clone for InitMask

fn clone(&self) -> InitMask

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InitMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__D: TyDecoder> Decodable<__D> for InitMask

fn decode(__decoder: &mut __D) -> Self

impl<__E: TyEncoder> Encodable<__E> for InitMask

fn encode(&self, __encoder: &mut __E)

impl Hash for InitMask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'__ctx> HashStable<StableHashingContext<'__ctx>> for InitMask

fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher, )

impl PartialEq for InitMask

fn eq(&self, other: &InitMask) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for InitMask

impl StructuralPartialEq for InitMask

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes