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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
// Copyright (c) 2021, BlockProject 3D
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of BlockProject 3D nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//! This library is the official implementation for the [BPX](https://gitlab.com/bp3d/bpx/bpx/-/blob/master/BPX_Format.pdf) container format.
use std::vec::Vec;
pub mod variant;
pub mod builder;
mod compression;
pub mod decoder;
pub mod encoder;
pub mod error;
mod garraylen;
pub mod header;
pub mod sd;
pub mod section;
pub mod strings;
pub mod utils;
/// Represents a pointer to a section.
///
/// *Allows indirect access to a given section instead of sharing mutable references in user code.*
#[derive(Copy, Clone, Debug)]
pub struct SectionHandle(usize);
/// The interface implemented by both the BPX encoder and decoder.
pub trait Interface
{
/// Searches for the first section of a given type.
/// Returns None if no section could be found.
///
/// # Arguments
///
/// * `btype`: section type byte.
///
/// returns: Option<SectionHandle>
///
/// # Examples
///
/// ```
/// use bpx::encoder::Encoder;
/// use bpx::Interface;
///
/// let file = Encoder::new(Vec::<u8>::new()).unwrap();
/// assert!(file.find_section_by_type(0).is_none());
/// ```
fn find_section_by_type(&self, btype: u8) -> Option<SectionHandle>;
/// Searches for all sections of a given type.
/// Returns None if no section could be found.
///
/// # Arguments
///
/// * `btype`: section type byte.
///
/// returns: Vec<SectionHandle, Global>
///
/// # Examples
///
/// ```
/// use bpx::encoder::Encoder;
/// use bpx::Interface;
///
/// let file = Encoder::new(Vec::<u8>::new()).unwrap();
/// assert_eq!(file.find_all_sections_of_type(0).len(), 0);
/// ```
fn find_all_sections_of_type(&self, btype: u8) -> Vec<SectionHandle>;
/// Locates a section by its index in the file.
/// Returns None if the section does not exist.
///
/// # Arguments
///
/// * `index`: the section index to search for.
///
/// returns: Option<SectionHandle>
///
/// # Examples
///
/// ```
/// use bpx::encoder::Encoder;
/// use bpx::Interface;
///
/// let file = Encoder::new(Vec::<u8>::new()).unwrap();
/// assert!(file.find_section_by_index(0).is_none());
/// ```
fn find_section_by_index(&self, index: u32) -> Option<SectionHandle>;
/// Returns the BPX section header of a section.
///
/// # Arguments
///
/// * `handle`: a handle to the section.
///
/// returns: &SectionHeader
///
/// # Panics
///
/// Panics if the given section handle is invalid.
///
/// # Examples
///
/// ```
/// use bpx::encoder::Encoder;
/// use bpx::Interface;
/// use bpx::builder::SectionHeaderBuilder;
///
/// let mut file = Encoder::new(Vec::<u8>::new()).unwrap();
/// let handle = file.create_section(SectionHeaderBuilder::new().with_type(1).build()).unwrap();
/// let header = file.get_section_header(handle);
/// assert_eq!(header.btype, 1);
/// ```
fn get_section_header(&self, handle: SectionHandle) -> &header::SectionHeader;
/// Returns the section index from a section handle.
///
/// # Arguments
///
/// * `handle`: a handle to the section.
///
/// returns: u32
///
/// # Panics
///
/// Panics if the given section handle is invalid.
///
/// # Examples
///
/// ```
/// use bpx::encoder::Encoder;
/// use bpx::Interface;
/// use bpx::builder::SectionHeaderBuilder;
///
/// let mut file = Encoder::new(Vec::<u8>::new()).unwrap();
/// let handle = file.create_section(SectionHeaderBuilder::new().build()).unwrap();
/// assert_eq!(file.get_section_index(handle), 0);
/// ```
fn get_section_index(&self, handle: SectionHandle) -> u32;
/// Opens a section for read and/or write.
///
/// # Arguments
///
/// * `handle`: a handle to the section.
///
/// returns: Result<&mut dyn SectionData, Error>
///
/// # Errors
///
/// A BPX [Error](error::Error) if an IO or any other file error occurs
/// while reading the section from the file.
///
/// # Panics
///
/// Panics if the given section handle is invalid.
///
/// # Examples
///
/// ```
/// use bpx::encoder::Encoder;
/// use bpx::Interface;
/// use bpx::builder::SectionHeaderBuilder;
///
/// let mut file = Encoder::new(Vec::<u8>::new()).unwrap();
/// let handle = file.create_section(SectionHeaderBuilder::new().build()).unwrap();
/// let section = file.open_section(handle).unwrap();
/// let data = section.load_in_memory().unwrap();
/// assert_eq!(data.len(), 0);
/// ```
fn open_section(&mut self, handle: SectionHandle) -> Result<&mut dyn section::SectionData>;
/// Returns a read-only reference to the BPX main header.
///
/// # Examples
///
/// ```
/// use bpx::encoder::Encoder;
/// use bpx::Interface;
/// use bpx::builder::SectionHeaderBuilder;
///
/// let mut file = Encoder::new(Vec::<u8>::new()).unwrap();
/// let header = file.get_main_header();
/// //Default BPX variant/type is 'P'
/// assert_eq!(header.btype, 'P' as u8);
/// ```
fn get_main_header(&self) -> &header::MainHeader;
}
/// Represents a result from this library.
///
/// *This acts as a shortcut to [Result](std::result::Result)<T, [Error](error::Error)>.*
pub type Result<T> = std::result::Result<T, error::Error>;