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

// 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 bpxp;
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*
pub type SectionHandle = usize;

/// The interface implemented by both the BPX encoder and decoder
pub trait Interface
{
    /// Searches for the first section of a given type
    ///
    /// # Arguments
    ///
    /// * `btype` - section type byte
    ///
    /// # Returns
    ///
    /// * None if no section could be found
    /// * a handle to the section
    fn find_section_by_type(&self, btype: u8) -> Option<SectionHandle>;

    /// Searches for all sections of a given type
    ///
    /// # Arguments
    ///
    /// * `btype` - section type byte
    ///
    /// # Returns
    ///
    /// * a list of handles from all sections matching the given type
    fn find_all_sections_of_type(&self, btype: u8) -> Vec<SectionHandle>;

    /// Locates a section by its index in the file
    ///
    /// # Arguments
    ///
    /// * `index` - the section index to search for
    ///
    /// # Returns
    ///
    /// * None if the section does not exist
    /// * a handle to the section
    fn find_section_by_index(&self, index: u32) -> Option<SectionHandle>;

    /// Gets the BPX section header
    ///
    /// *panics if the given section handle is invalid*
    ///
    /// # Arguments
    ///
    /// * `handle` - a handle to the section
    ///
    /// # Returns
    ///
    /// * read-only reference to the BPX section header
    fn get_section_header(&self, handle: SectionHandle) -> &header::SectionHeader;

    /// Opens a section for read and/or write
    ///
    /// *panics if the given section handle is invalid*
    ///
    /// # Arguments
    ///
    /// * `handle` - a handle to the section
    ///
    /// # Returns
    ///
    /// * reference to the section data
    fn open_section(&mut self, handle: SectionHandle) -> Result<&mut dyn section::SectionData>;

    /// Gets the BPX main header
    ///
    /// # Returns
    ///
    /// * read-only reference to the BPX main header
    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>;