16 releases (9 breaking)

0.10.0 Apr 15, 2024
0.9.0 Oct 24, 2023
0.8.1 Jun 20, 2023
0.7.3 Jul 5, 2022
0.1.0 Mar 20, 2017

#151 in Parser implementations

Download history 121707/week @ 2024-06-24 120350/week @ 2024-07-01 140677/week @ 2024-07-08 143705/week @ 2024-07-15 153497/week @ 2024-07-22 141828/week @ 2024-07-29 159327/week @ 2024-08-05 153535/week @ 2024-08-12 166786/week @ 2024-08-19 165994/week @ 2024-08-26 160503/week @ 2024-09-02 151797/week @ 2024-09-09 144342/week @ 2024-09-16 154583/week @ 2024-09-23 144663/week @ 2024-09-30 144070/week @ 2024-10-07

596,599 downloads per month
Used in 30 crates (10 directly)

MIT license

225KB
5K SLoC

Contains (Cab file, 17KB) loop_in_chain, (Cab file, 17KB) tests/panics_fuzzed/alloc_panic, (Cab file, 17KB) tests/panics_fuzzed/minialloc_panic, (Cab file, 15KB) loop_in_alloc, (Cab file, 14KB) loop_in_directory, (Cab file, 15KB) loop_in_minialloc and 3 more.

rust-cfb

Build Status Crates.io Documentation

A Rust library for reading/writing Compound File Binary (structured storage) files. See MS-CFB for the format specification.

License

rust-cfb is made available under the MIT License.


lib.rs:

A library for reading/writing Compound File Binary (structured storage) files. See MS-CFB for the format specification.

A Compound File Binary (CFB) file, also called a structured storage file or simply a compound file, is a bit like a simple file system within a file. A compound file contains a tree of storage objects (i.e. directories), each of which can contain stream objects (i.e. files) or other storage objects. The format is designed to allow reasonably efficient in-place mutation and resizing of these stream and storage objects, without having to completely rewrite the CFB file on disk.

Example usage

use cfb;
use std::io::{Read, Seek, SeekFrom, Write};

// Open an existing compound file in read-write mode.
let mut comp = cfb::open_rw("path/to/cfb/file").unwrap();

// Read in all the data from one of the streams in that compound file.
let data = {
    let mut stream = comp.open_stream("/foo/bar").unwrap();
    let mut buffer = Vec::new();
    stream.read_to_end(&mut buffer).unwrap();
    buffer
};

// Append that data to the end of another stream in the same file.
{
    let mut stream = comp.open_stream("/baz").unwrap();
    stream.seek(SeekFrom::End(0)).unwrap();
    stream.write_all(&data).unwrap();
}

// Now create a new compound file, and create a new stream with the data.
let mut comp2 = cfb::create("some/other/path").unwrap();
comp2.create_storage("/spam/").unwrap();
let mut stream = comp2.create_stream("/spam/eggs").unwrap();
stream.write_all(&data).unwrap();

Dependencies

~360KB