Expand description
Set the minimum alignments of types using const generics, rather
than #[repr(align(N))]
.
§Basic Use
The type Align<N>
is a zero-sized-type with alignment
equal to N
:
use elain::Align;
use core::mem::{align_of, align_of_val};
assert_eq!(align_of::<Align<1>>(), 1);
assert_eq!(align_of::<Align<2>>(), 2);
assert_eq!(align_of::<Align<4>>(), 4);
const FOO_ALIGN: usize = 8;
#[repr(C)]
struct Foo {
_align: Align<FOO_ALIGN>,
}
let foo: Foo = Foo { _align: Align::NEW };
assert_eq!(align_of_val(&foo), 8);
Valid alignments are powers of two less-than-or-equal to 229.
Supplying an invalid alignment to Align
is a type error:
ⓘ
use elain::Align;
struct Foo(Align<3>); // Compile Error
§Generic Use
Because only some integers are valid alignments, supplying the alignment of a type generically requires some extra work:
ⓘ
use elain::Align;
#[repr(C)]
struct Foo<const N: usize> {
_align: Align<N>,
}
To resolve this error, add a where
bound like so, using the
Alignment
trait to check that Align<N>
is valid.
use elain::{Align, Alignment};
use core::mem::align_of;
#[repr(C)]
struct Foo<const MIN_ALIGNMENT: usize>
where
Align<MIN_ALIGNMENT>: Alignment
{
_align: Align<MIN_ALIGNMENT>,
bar: u8,
baz: u16,
}
assert_eq!(align_of::<Foo<1>>(), 2);
assert_eq!(align_of::<Foo<2>>(), 2);
assert_eq!(align_of::<Foo<4>>(), 4);
Structs§
- A zero-sized-type aligned to
N
. Compound types containing a fieldAlign<N>
with have an alignment of at leastN
.
Traits§
- Implemented for all
Align<N>
whereN
is a valid alignment (i.e., a power of two less-than-or-equal to 228).