A high-level PDF manipulation library built on lopdf, focusing on ease of use and powerful abstractions for common PDF operations following the ISO 32000-2 standard.
- Optional Content Groups (OCG): Easy creation and management of PDF layers
- Layer Management: High-level API for organizing content into toggleable layers
- Hatching Patterns: Support for various fill patterns including crosshatching, dots, and custom patterns
- PDF Embedding: Embed other PDF documents with various layout strategies
- Type Safety: Strongly typed interfaces with compile-time guarantees
use hipdf::ocg::{OCGManager, Layer, LayerContentBuilder, LayerOperations as Ops};
use lopdf::{Document, Object};
// Create a new PDF with layers
let mut doc = Document::with_version("1.5");
let mut ocg_manager = OCGManager::with_config(Default::default());
// Add layers
ocg_manager.add_layer(Layer::new("Background", true));
ocg_manager.add_layer(Layer::new("Main Content", true));
ocg_manager.add_layer(Layer::new("Annotations", false));
// Initialize layers in document
ocg_manager.initialize(&mut doc);
// Build content for specific layers
let mut builder = LayerContentBuilder::new();
builder.begin_layer("L0")
.add_operation(Ops::rectangle(50.0, 50.0, 200.0, 100.0))
.add_operation(Ops::fill())
.end_layer();use hipdf::hatching::{HatchingManager, HatchStyle, PatternedShapeBuilder};
// Create a hatching manager
let mut manager = HatchingManager::new();
// Add a diagonal pattern
let pattern_id = manager.add_pattern(HatchStyle::DiagonalRight, 5.0, 1.0);
// Create a shape with the pattern
let mut builder = PatternedShapeBuilder::new();
builder.rectangle(100.0, 100.0, 200.0, 150.0, &pattern_id);use hipdf::embed_pdf::{PdfEmbedder, EmbedOptions, MultiPageLayout};
// Create an embedder
let mut embedder = PdfEmbedder::new();
// Load a PDF
embedder.load_pdf("source.pdf", "doc1")?;
let options = EmbedOptions {
layout: MultiPageLayout::Vertical { gap: 10.0 },
scale: 1.0,
..Default::default()
};
// Embed into target document
embedder.embed_pdf(&mut target_doc, "doc1", &options)?;- [
ocg] - Optional Content Groups (layers) functionality - [
hatching] - Hatching and pattern support for PDF documents - [
embed_pdf] - PDF embedding and composition support
use hipdf::ocg::{OCGManager, Layer};
// Create layer manager
let mut manager = OCGManager::new();
// Add layers with different visibility settings
manager.add_layer(Layer::new("Background", true));
manager.add_layer(Layer::new("Content", true));
manager.add_layer(Layer::new("Debug", false));
// Initialize in PDF document
manager.initialize(&mut doc);use hipdf::hatching::{CustomPatternBuilder, HatchStyle};
// Create custom pattern
let mut pattern_builder = CustomPatternBuilder::new();
pattern_builder
.move_to(0.0, 0.0)
.line_to(10.0, 10.0)
.line_to(20.0, 0.0);
// Register the pattern
let custom_pattern_id = manager.add_custom_pattern(pattern_builder.build());use hipdf::embed_pdf::{EmbedLayoutBuilder, LayoutStrategy};
// Create layout builder
let mut layout_builder = EmbedLayoutBuilder::new();
// Add multiple PDFs with different layouts
layout_builder
.add_pdf("doc1.pdf", LayoutStrategy::SinglePage { x: 0.0, y: 0.0 })
.add_pdf("doc2.pdf", LayoutStrategy::Grid {
columns: 2,
spacing: 10.0
});
// Generate the final document
let final_doc = layout_builder.build()?;- Rust 1.70+
- lopdf 0.38.0
This project is licensed under the MIT License - see the LICENSE file for details.
Contributions are welcome! Please feel free to submit a Pull Request.
For complete API documentation, visit docs.rs/hipdf.