apple_bom/
lib.rs

1// Copyright 2022 Gregory Szorc.
2//
3// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
4// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
5// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
6// option. This file may not be copied, modified, or distributed
7// except according to those terms.
8
9//! Interact with Apple BOM files.
10//!
11//! Apple Bill of Materials (BOM) files are a file format / data structure
12//! for indexing file content with additional metadata. They are commonly
13//! found in flat packages (e.g. `.pkg` files).
14//!
15//! This crate provides an interface for reading and writing Apple BOM
16//! files.
17//!
18//! The gateway to reading support is [ParsedBom], which provides a read-only
19//! interface to a BOM data structure.
20//!
21//! Writing support is still a work in progress.
22
23pub mod builder;
24pub mod error;
25pub use error::Error;
26pub mod format;
27pub use format::ParsedBom;
28pub mod path;
29
30pub use path::{BomPath, BomPathType};