Custom `Read` on uninitialized buffer may cause undefined behavior

serde-gff

Generic File Format (GFF) -- формат файлов, используемый играми на движке Bioware Aurora: Newerwinter Nights, The Witcher и Newerwinter Nights 2.

Формат имеет некоторые ограничения:

элементами верхнего уровня могут быть только структуры или перечисления Rust в unit или struct варианте
имена полей структур не должны быть длиннее 16 байт в UTF-8. При нарушении при сериализации будет ошибка
то же самое касается ключей карт. Кроме того, ключами могут быть только строки (&str или String)

Установка

Выполните в корне проекта

cargo add serde_gff

или добавьте следующую строку в Cargo.toml:

[dependencies]
serde_gff = "0.2"

Пример

use std::f32::consts::PI;
use std::f64::consts::E;
use std::io::Cursor;
use serde::{Serialize, Deserialize};

use serde_gff::de::Deserializer;
use serde_gff::ser::to_vec;
use serde_gff::value::Value;

#[derive(Debug, Serialize, Deserialize)]
struct Item { u8: u8, i8: i8 }

#[derive(Debug, Serialize, Deserialize)]
struct Struct {
  f32: f32,
  f64: f64,

  #[serde(with = "serde_bytes")]
  bytes: Vec<u8>,
}

#[derive(Debug, Serialize, Deserialize)]
#[allow(non_snake_case)]
struct Test {
  u16: u16,
  i16: i16,
  u32: u32,
  i32: i32,
  u64: u64,
  i64: i64,

  string: String,

  Struct: Struct,
  list: Vec<Item>,
}

fn main() {
  let data = Test {
    u16: 1, i16: 2,
    u32: 3, i32: 4,
    u64: 5, i64: 6,

    string: "String".into(),

    Struct: Struct { f32: PI, f64: E, bytes: b"Vec<u8>".to_vec() },
    list: vec![
      Item { u8: 7, i8:  -8 },
      Item { u8: 9, i8: -10 },
    ],
  };

  let mut vec = to_vec((*b"GFF ").into(), &data).expect("can't write data");
  // Важный нюанс - не забыть, что создание десериализатора читает заголовок и возвращает
  // Result, а не сам десериализатор, поэтому требуется распаковка результата
  let mut de = Deserializer::new(Cursor::new(vec)).expect("can't read GFF header");
  let val = Value::deserialize(&mut de).expect("can't deserialize data");

  println!("{:#?}", val);
}

	pub fn read_resref(&mut self, index: ResRefIndex) -> Result<ResRef> {
	self.seek(index)?;

	let size = self.reader.read_u8()? as usize;
	let mut bytes = Vec::with_capacity(size);
	unsafe { bytes.set_len(size); }

	self.reader.read_exact(&mut bytes)?;
	Ok(ResRef(bytes))
	}

	#[inline]
	fn read_bytes(&mut self) -> Result<Vec<u8>> {
	let size = self.read_u32()? as usize;
	let mut bytes = Vec::with_capacity(size);
	unsafe { bytes.set_len(size); }

	self.reader.read_exact(&mut bytes)?;
	Ok(bytes)
	}

	pub fn read<R: Read + Seek>(reader: &mut R) -> Result<Gff> {
	let header = Header::read(reader)?;
	let structs = read_exact!(reader, header.structs, Struct);
	let fields = read_exact!(reader, header.fields , Field);

	reader.seek(SeekFrom::Start(header.labels.offset as u64))?;
	let mut labels = Vec::with_capacity(header.labels.count as usize);
	for _ in 0..header.labels.count {
	let mut label = [0u8; 16];
	reader.read_exact(&mut label)?;
	labels.push(label.into());
	}

	reader.seek(SeekFrom::Start(header.field_data.offset as u64))?;
	let mut field_data = Vec::with_capacity(header.field_data.count as usize);
	unsafe { field_data.set_len(header.field_data.count as usize); }
	reader.read_exact(&mut field_data[..])?;

	let field_indices = read_into!(reader, header.field_indices);
	let list_indices = read_into!(reader, header.list_indices);

	Ok(Gff { header, structs, fields, labels, field_data, field_indices, list_indices })
	}

	macro_rules! read_into {
	($reader:expr, $section:expr) => ({
	$reader.seek(SeekFrom::Start($section.offset as u64))?;
	let mut vec = Vec::with_capacity($section.count as usize);
	unsafe { vec.set_len(($section.count / 4) as usize); }
	$reader.read_u32_into::<LE>(&mut vec[..])?;
	vec
	});
	}

mingun / serde-gff Goto Github PK

serde-gff's Introduction

serde-gff

Установка

Пример

serde-gff's People

Contributors

Watchers

serde-gff's Issues

Custom `Read` on uninitialized buffer may cause undefined behavior

Issue Description

How to fix the issue?

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent