ensure-uniform-type

Crates.ioensure-uniform-type
lib.rsensure-uniform-type
version0.1.1
sourcesrc
created_at2024-06-15 14:22:40.031415
updated_at2024-06-15 14:39:49.607082
descriptionEnsures a type only uses uniform fields
homepagehttps://github.com/sunsided/ensure-uniform-type-rs
repositoryhttps://github.com/sunsided/ensure-uniform-type-rs
max_upload_size
id1272926
size22,933
Markus Mayer (sunsided)

documentation

README

#[ensure_uniform_type]: Ensure uniform struct field types at compile-time

Crates.io Crates.io GitHub Workflow Status docs.rs

A compile-time check to ensure that a type uses uniform types across its fields.

An example use for this macro is to ensure that a struct #[repr(C)] layout can be correctly mapped onto a slice of the (uniform) field type.

Example

Assume the following type:

#[ensure_uniform_type]
pub struct Example<T>
{
    /// First field
    x: T,

    // Different type
    offending: u32,
}

The above would fail to compile, instead giving the error:

error: Struct DifferentialDriveState has fields of different types. Expected uniform use of T, found u32 in field offending.
  --> src/differential_drive.rs:16:1
   |
16 | / /// A state of a differential drive robot, or differential wheeled robot.
18 | | #[ensure_uniform_type]
19 | | pub struct Example<T>
...  |
37 | |     offending: u32,
38 | | }
   | |_^

By contrast, the following would compile without an error:

#[ensure_uniform_type]
pub struct Example<T>
{
    x: T,
    not_offending: T,
}
Commit count: 10

cargo fmt