1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
#![forbid(unsafe_code)] #![forbid(missing_docs)] //! This is a crate for saving and loading .ttb files. //! //! # Examples //! //! Basic usage: //! //! ```rust //! use { //! std::{ //! io::{ //! Cursor, //! }, //! }, //! ttb::{ //! Reader, //! ReaderEvent, //! Writer, //! }, //! regenboog::{ //! RgbaU8, //! }, //! }; //! //! let mut buf = [0; 1024]; //! //! let write_cursor = Cursor::new(&mut buf[..]); //! //! let mut writer = Writer::new(write_cursor); //! //! writer.write_header("Test", "This is a test. Meow.", &[ //! RgbaU8::WHITE, //! RgbaU8::BLACK, //! RgbaU8::RED, //! RgbaU8::GREEN, //! RgbaU8::BLUE, //! ]).unwrap(); //! //! writer.write_brick("1x1 Brick", 0, 0, 0, 0, 0).unwrap(); //! writer.write_brick("1x1 Brick", 0, 3, 0, 0, 1).unwrap(); //! writer.write_brick("1x1 Brick", 0, 6, 0, 0, 2).unwrap(); //! writer.write_brick("1x1 Brick", 0, 9, 0, 0, 3).unwrap(); //! writer.write_brick("1x1 Plate", 0, 10, 0, 0, 4).unwrap(); //! //! writer.finish().unwrap(); //! //! let read_cursor = Cursor::new(&buf[..]); //! //! let mut reader = Reader::new(read_cursor); //! //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Meta { //! build_name: "Test", //! build_description: "This is a test. Meow.", //! })); //! //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Color { //! id: 0, //! color: RgbaU8::WHITE, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Color { //! id: 1, //! color: RgbaU8::BLACK, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Color { //! id: 2, //! color: RgbaU8::RED, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Color { //! id: 3, //! color: RgbaU8::GREEN, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Color { //! id: 4, //! color: RgbaU8::BLUE, //! })); //! //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Brick { //! brick_type: "1x1 Brick", //! x: 0, //! y: 0, //! z: 0, //! orientation: 0, //! color_id: 0, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Brick { //! brick_type: "1x1 Brick", //! x: 0, //! y: 3, //! z: 0, //! orientation: 0, //! color_id: 1, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Brick { //! brick_type: "1x1 Brick", //! x: 0, //! y: 6, //! z: 0, //! orientation: 0, //! color_id: 2, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Brick { //! brick_type: "1x1 Brick", //! x: 0, //! y: 9, //! z: 0, //! orientation: 0, //! color_id: 3, //! })); //! assert_eq!(reader.next_event().unwrap(), Some(ReaderEvent::Brick { //! brick_type: "1x1 Plate", //! x: 0, //! y: 10, //! z: 0, //! orientation: 0, //! color_id: 4, //! })); //! ``` /// The magic number at the front of a .ttb file. pub const MAGIC_NUMBER: &[u8] = b"ttb"; /// The current version of the TTB format this crate writes. pub const VERSION: u8 = 1; mod reader; mod writer; pub use { reader::{ Reader, Event as ReaderEvent, Error as ReaderError, }, writer::{ Writer, }, };