How to convert ‘struct’ to ‘&[u8]’?

by

A correctly sized struct as zero-copied bytes can be done using stdlib and a generic function.

In the example below there there is a reusable function called any_as_u8_slice instead of convert_struct, since this is a utility to wrap cast and slice creation.

Note that the question asks about converting, this example creates a read-only slice, so has the advantage of not needing to copy the memory.

Heres a working example based on the question:

unsafe fn any_as_u8_slice<T: Sized>(p: &T) -> &[u8] {
    ::std::slice::from_raw_parts(
        (p as *const T) as *const u8,
        ::std::mem::size_of::<T>(),
    )
}

fn main() {
    struct MyStruct {
        id: u8,
        data: [u8; 1024],
    }
    let my_struct = MyStruct { id: 0, data: [1; 1024] };
    let bytes: &[u8] = unsafe { any_as_u8_slice(&my_struct) };
    // tcp_stream.write(bytes);
    println!("{:?}", bytes);
}

Note 1) even though 3rd party crates might be better in some cases, this is such a primitive operation that its useful to know how to do in Rust.

Note 2) at time of writing (Rust 1.15), there is no support for const functions. Once there is, it will be possible to cast into a fixed sized array instead of a slice.

Note 3) the any_as_u8_slice function is marked unsafe because any padding bytes in the struct may be uninitialized memory (giving undefined behavior).
If there were a way to ensure input arguments used only structs which were #[repr(packed)], then it could be safe.

Otherwise the function is fairly safe since it prevents buffer over-run since the output is read-only, fixed number of bytes, and its lifetime is bound to the input.
If you wanted a version that returned a &mut [u8], that would be quite dangerous since modifying could easily create inconsistent/corrupt data.

More Related Contents:

  1. Why is a trait not implemented for a type that clearly has it implemented?
  2. How can I include a module from another file from the same project?
  3. What does “Sized is not implemented” mean?
  4. How do I implement a trait I don’t own for a type I don’t own?
  5. How do I implement Copy and Clone for a type that contains a String (or any type that doesn’t implement Copy)?
  6. What makes something a “trait object”?
  7. How to do a binary search on a Vec of floats?
  8. Change enum variant while moving the field to the new variant
  9. When is it useful to define multiple lifetimes in a struct?
  10. Can I write an Iterator that mutates itself and then yields a reference into itself?
  11. How does the mechanism behind the creation of boxed traits work?
  12. What is the syntax: `instance.method::()`?
  13. Why does passing a closure to function which accepts a function pointer not work?
  14. “expected type parameter, found struct”
  15. Adding an append method to a singly linked list
  16. Is it possible to declare the type of the variable in Rust for loops?
  17. Lifetime of variables passed to a new thread
  18. How can I co-sort two Vecs based on the values in one of the Vecs?
  19. Is there a way to combine multiple traits in order to define a new trait? [duplicate]
  20. How to switch between Rust toolchains?
  21. What does “missing lifetime specifier” mean when storing a &str in a structure?
  22. How do I specify that a struct field must implement a trait?
  23. How do I print an integer in binary with leading zeros?
  24. How to create and write to memory mapped files?
  25. How does Rust’s type inference work across multiple statements?
  26. Downcast traits inside Rc for AST manipulation
  27. Why does Valgrind not detect a memory leak in a Rust program using nightly 1.29.0?
  28. What is the null pointer optimization in Rust?
  29. Is there any way to restrict a generic type to one of several types?
  30. How to pass rustc flags to cargo?

Leave a Comment