Struct MarkedContent 

pub struct MarkedContent { /* private fields */ }

Marked content builder for Tagged PDF

Implementations

impl MarkedContent

pub fn new() -> Self

Creates a new marked content builder

pub fn begin(&mut self, tag: &str) -> Result<&mut Self>

Begin marked content without properties (BMC operator)

Arguments

• tag - Structure type tag (e.g., “P” for paragraph, “H1” for heading)

Example

use oxidize_pdf::structure::MarkedContent;

let mut mc = MarkedContent::new();
mc.begin("P");
// ... add content ...
mc.end();

pub fn begin_with_mcid(&mut self, tag: &str, mcid: u32) -> Result<&mut Self>

Begin marked content with properties dictionary (BDC operator)

This is the primary method for Tagged PDF, as it allows specifying the MCID (Marked Content ID) that links content to structure elements.

Arguments

• tag - Structure type tag (e.g., “P”, “H1”, “Figure”)
• mcid - Marked Content ID linking to structure tree

Example

use oxidize_pdf::structure::MarkedContent;

let mut mc = MarkedContent::new();
mc.begin_with_mcid("P", 0)?;
// ... add paragraph content ...
mc.end()?;

pub fn begin_with_typed_properties( &mut self, tag: &str, properties: &[MarkedContentProperty], ) -> Result<&mut Self>

Begin marked content with typed properties (BDC operator)

This is a type-safe alternative to begin_with_properties that uses an enum for common marked content properties.

Arguments

• tag - Structure type tag
• properties - Typed properties (MCID, Lang, ActualText, etc.)

Example

use oxidize_pdf::structure::{MarkedContent, MarkedContentProperty};

let mut mc = MarkedContent::new();
let props = vec![
    MarkedContentProperty::MCID(0),
    MarkedContentProperty::Lang("en-US".to_string()),
];
mc.begin_with_typed_properties("P", &props)?;

pub fn begin_with_properties( &mut self, tag: &str, properties: &[(&str, &str)], ) -> Result<&mut Self>

Begin marked content with custom properties dictionary

Allows specifying additional properties beyond MCID.

Arguments

• tag - Structure type tag
• properties - Dictionary entries as key-value pairs

Example

use oxidize_pdf::structure::MarkedContent;

let mut mc = MarkedContent::new();
let props = vec![("MCID", "0"), ("Lang", "(en-US)")];
mc.begin_with_properties("P", &props)?;

pub fn end(&mut self) -> Result<&mut Self>

End marked content (EMC operator)

Closes the most recently opened marked content section.

Errors

Returns an error if there are no open marked content sections.

Example

use oxidize_pdf::structure::MarkedContent;

let mut mc = MarkedContent::new();
mc.begin("P")?;
mc.end()?; // Closes the "P" section

pub fn has_open_sections(&self) -> bool

Returns true if there are open marked content sections

pub fn open_section_count(&self) -> usize

Returns the number of open marked content sections

pub fn tag_stack(&self) -> &[String]

Get the current tag stack (for debugging/validation)

pub fn finish(self) -> Result<String>

Finishes marked content generation and returns the PDF operators

Errors

Returns an error if there are still open marked content sections.

Example

use oxidize_pdf::structure::MarkedContent;

let mut mc = MarkedContent::new();
mc.begin_with_mcid("P", 0)?;
mc.end()?;
let operators = mc.finish()?;
assert!(operators.contains("BMC") || operators.contains("BDC"));
assert!(operators.contains("EMC"));

pub fn operations(&self) -> &str

Returns the operations string without consuming self

Unlike finish(), this does not validate that all sections are closed. Useful for incremental content generation.

pub fn reset(&mut self)

Clears all operations and resets the tag stack

Useful for reusing the builder for multiple content sections.

Trait Implementations

impl Clone for MarkedContent

fn clone(&self) -> MarkedContent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MarkedContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MarkedContent

fn default() -> Self

Returns the “default value” for a type.