Function bitvec::slice::from_raw_parts_unchecked_mut

source · 
pub unsafe fn from_raw_parts_unchecked_mut<'a, T, O>(
    ptr: BitPtr<Mut, T, O>,
    len: usize
) -> &'a mut BitSlice<T, O> ⓘwhere
    O: BitOrder,
    T: 'a + BitStore,
Expand description

Raw Bit-Slice Construction

This is equivalent to slice::from_raw_parts_mut(), except that it does not check any of the encoding requirements.

Safety

Callers must both uphold the safety requirements of that function, as well as ensure that the arguments would not cause it to fail gracefully.

Arguments that would cause from_raw_parts_mut to return Err instead produce a bit-slice handle whose value is undefined.

Parameters

  1. ptr: A bit-pointer to a T memory element. The pointer’s data address must be well-aligned, the bit-index must be valid for T, the target region must be initialized for len bits.
  2. len: A count of live bits beginning at ptr. It must not exceed MAX_BITS.

Returns

An exclusive BitSlice reference over the described region. If either of the parameters are invalid, then the value of the reference is library-level undefined. If any other reference, BitSlice or not, targets any of the bits that this reference governs while it is alive, then behavior is language-level undefined.