How to read a struct from a file in Rust?

by

Here you go:

use std::io::Read;
use std::mem;
use std::slice;

#[repr(C, packed)]
#[derive(Debug, Copy, Clone)]
struct Configuration {
    item1: u8,
    item2: u16,
    item3: i32,
    item4: [char; 8],
}

const CONFIG_DATA: &[u8] = &[
    0xfd, // u8
    0xb4, 0x50, // u16
    0x45, 0xcd, 0x3c, 0x15, // i32
    0x71, 0x3c, 0x87, 0xff, // char
    0xe8, 0x5d, 0x20, 0xe7, // char
    0x5f, 0x38, 0x05, 0x4a, // char
    0xc4, 0x58, 0x8f, 0xdc, // char
    0x67, 0x1d, 0xb4, 0x64, // char
    0xf2, 0xc5, 0x2c, 0x15, // char
    0xd8, 0x9a, 0xae, 0x23, // char
    0x7d, 0xce, 0x4b, 0xeb, // char
];

fn main() {
    let mut buffer = CONFIG_DATA;

    let mut config: Configuration = unsafe { mem::zeroed() };

    let config_size = mem::size_of::<Configuration>();
    unsafe {
        let config_slice = slice::from_raw_parts_mut(&mut config as *mut _ as *mut u8, config_size);
        // `read_exact()` comes from `Read` impl for `&[u8]`
        buffer.read_exact(config_slice).unwrap();
    }

    println!("Read structure: {:#?}", config);
}

Try it here (Updated for Rust 1.38)

You need to be careful, however, as unsafe code is, well, unsafe. After the slice::from_raw_parts_mut() invocation, there exist two mutable handles to the same data at the same time, which is a violation of Rust aliasing rules. Therefore you would want to keep the mutable slice created out of a structure for the shortest possible time. I also assume that you know about endianness issues – the code above is by no means portable, and will return different results if compiled and run on different kinds of machines (ARM vs x86, for example).

If you can choose the format and you want a compact binary one, consider using bincode. Otherwise, if you need e.g. to parse some pre-defined binary structure, byteorder crate is the way to go.

More Related Contents:

  1. How to idiomatically / efficiently pipe data from Read+Seek to Write?
  2. Reading from a TcpStream with Read::read_to_string hangs until the connection is closed by the remote end
  3. Read a file line by line in Prolog
  4. How are the O_SYNC and O_DIRECT flags in open(2) different/alike?
  5. MPI Reading from a text file
  6. How do I read the output of a child process without blocking in Rust?
  7. Why are explicit lifetimes needed in Rust?
  8. What does “dyn” mean in a type?
  9. Why can’t Rust infer the resulting type of Iterator::sum?
  10. What does “`str` does not have a constant size known at compile-time” mean, and what’s the simplest way to fix it?
  11. Iterator returning items by reference, lifetime issue
  12. Why is the mutable reference not moved here?
  13. Conflicting implementations of trait in Rust
  14. How do I use static lifetimes with threads?
  15. Processing vec in parallel: how to do safely, or without using unstable features?
  16. How can I create a function with a variable number of arguments?
  17. Show u8 slice in hex representation
  18. Haskell: I/O and Returning From a Function
  19. How do I make an Rust item public within a crate, but private outside it?
  20. Type mismatches resolving a closure that takes arguments by reference
  21. open file in exclusive mode in C#
  22. Reading a file using a relative path in a Python project
  23. How can I initialize an array using a function? [duplicate]
  24. Creating a vector of zeros for a specific size
  25. How to check release / debug builds using cfg in Rust?
  26. What is the difference between immutable and const variables in Rust?
  27. How to iterate through a Hashmap, print the key/value and remove the value in Rust?
  28. What does it mean to instantiate a Rust generic with an underscore?
  29. How to print structs and arrays?
  30. Test if a file is an image file

Leave a Comment