Memory utility library

Types

• Luna::Unconstructed

  Represents one object that supports manual construction and destruction.

• Luna::MemoryLayoutMember

  Describes one member used by memory layouting algorithms.

Functions

• void * memzero(void *dst, usize byte_count)

  Clears the specified memory region to 0.

• _Ty * memzero(_Ty *dst)

  Clears the memory of the specified object to 0.

• void * memcpy_bitmap(void dst, const void src, usize copy_size_per_row, usize num_rows, usize dst_row_pitch, usize src_row_pitch)

  Copies the data for a 2D bitmap.

• void * memcpy_bitmap3d(void dst, const void src, usize copy_size_per_row, usize num_rows, usize num_slices, usize dst_row_pitch, usize src_row_pitch, usize dst_slice_pitch, usize src_slice_pitch)

  Copies the data for a 3D bitmap.

• void * pixel_offset(void *base, usize x, usize y, usize z, usize bytes_per_pixel, usize row_pitch, usize slice_pitch)

  Returns a pointer that offsets the specified pixels in the bitmap.

• const void * pixel_offset(const void *base, usize x, usize y, usize z, usize bytes_per_pixel, usize row_pitch, usize slice_pitch)

  Returns a pointer that offsets the specified pixels in the bitmap.

• constexpr unsigned long long operator""_kb(unsigned long long v)

  A integer literal suffix that multiples one number with 1024. Use it like 3_kb.

• constexpr unsigned long long operator""_mb(unsigned long long v)

  A integer literal suffix that multiples one number with 1024 * 1024. Use it like 3_mb.

• constexpr unsigned long long operator""_gb(unsigned long long v)

  A integer literal suffix that multiples one number with 1024 * 1024 * 1024. Use it like 3_gb.

• constexpr unsigned long long operator""_tb(unsigned long long v)

  A integer literal suffix that multiples one number with 1024 * 1024 * 1024 * 1024. Use it like 3_tb.

• bool bit_test(const void *base_addr, usize bit_offset)

  Tests if specified bit is 1.

• void bit_set(void *addr, usize bit_offset)

  Sets the specified bit to 1.

• void bit_reset(void *addr, usize bit_offset)

  Sets the specified bit to 0.

• void bit_set(void *addr, usize bit_offset, bool value)

  Sets the specified bit to 1 if value is true, or to 0 if value is false.

• constexpr _Ty1 align_upper(_Ty1 origin, _Ty2 alignment)

  Returns the address/size that aligns the origin address/size to the nearest matched aligned address/size that is greater than or equal to the the origin address/size.

• _Ty * addressof(_Ty &value)

  Gets the real address for object or function value, even if the operator& of the object has been overloaded.

• void default_construct(_Iter dst)

  Calls the default constructor for the object.

• void value_construct(_Iter dst)

  Calls the value constructor for the object.

• void copy_construct(_Iter1 dst, _Iter2 src)

  Calls the copy constructor for the object.

• void move_construct(_Iter1 dst, _Iter2 src)

  Calls the move constructor for the object.

• void direct_construct(_Iter dst, _Args &&... args)

  Calls the direct constructor for the object.

• void destruct(_Iter dst)

  Calls the destructor of the object.

• void copy_assign(_Iter1 dst, _Iter2 src)

  Calls the copy assignment operator of the object.

• void move_assign(_Iter1 dst, _Iter2 src)

  Calls the move assignment operator of the object.

• auto default_construct_range(_Iter first, _Iter last) -> enable_if_t< Impl::default_construct_range_is_value_type_class< _Iter >::value, void >

  Default-constructs a range of objects.

• auto value_construct_range(_Iter first, _Iter last) -> enable_if_t< Impl::value_construct_range_is_value_type_trivial< _Iter >::value, void >

  Value-constructs a range of objects.

• auto copy_construct_range(_Iter1 first, _Iter1 last, _Iter2 d_first) -> enable_if_t<!Impl::copy_construct_range_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Copy-constructs a range of objects.

• auto copy_construct_range_n(_Iter1 first, usize count, _Iter2 d_first) -> enable_if_t<!Impl::copy_construct_range_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Copy-constructs a range of objects. The range is provided by first object and object count.

• auto move_construct_range(_Iter1 first, _Iter1 last, _Iter2 d_first) -> enable_if_t< Impl::move_construct_range_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Move-constructs a range of objects.

• auto destruct_range(_Iter first, _Iter last) -> enable_if_t< Impl::destruct_range_is_value_type_trivial< _Iter >::value, void >

  Destructs every object in the range.

• auto copy_assign_range(_Iter1 first, _Iter1 last, _Iter2 d_first) -> enable_if_t<!Impl::copy_assign_range_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Performs copy assignment operation on every object in the destination range using the corresponding object in the source range.

• auto move_assign_range(_Iter1 first, _Iter1 last, _Iter2 d_first) -> enable_if_t<!Impl::move_assign_range_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Performs move assignment operation on every object in the destination range using the corresponding object in the source range.

• auto move_assign_range_backward(_Iter1 first, _Iter1 last, _Iter2 d_last) -> enable_if_t<!Impl::move_assign_range_backward_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Same as move_assign_range, but performs the move assign from back to front.

• _Iter1 fill_construct_range(_Iter1 first, _Iter1 last, const _Ty &value)

  Performs copy construct on each of the object in the range by taking a copy of the provided object.

• _Iter1 fill_assign_range(_Iter1 first, _Iter1 last, const _Ty &value)

  Performs copy assignment on each of the object in the range by taking a copy of the provided object.

• auto copy_relocate_range(_Iter1 first, _Iter1 last, _Iter2 d_first) -> enable_if_t< Impl::copy_relocate_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Relocates objects in the source range to a new range that is not overlap with the source range.

• auto copy_relocate(_Iter1 dst, _Iter2 src) -> enable_if_t< Impl::copy_relocate_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter1 >

  Relocates one object.

• auto move_relocate_range(_Iter1 first, _Iter1 last, _Iter2 d_first) -> enable_if_t< Impl::move_relocate_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Relocates objects in the source range to a new range.

• auto move_relocate_range_backward(_Iter1 first, _Iter1 last, _Iter2 d_last) -> enable_if_t< Impl::move_relocate_backward_is_value_type_trivial< _Iter1, _Iter2 >::value, _Iter2 >

  Relocates objects in the source range to a new range.

• void calculate_struct_memory_layout(Span< MemoryLayoutMember > members, usize &out_size, usize &out_alignment)

  Calculates the size, alignment and memory layout for one structure type.

• void calculate_union_memory_layout(Span< MemoryLayoutMember > members, usize &out_size, usize &out_alignment)

  Calculates the size, alignment and memory layout for one union type.