OfficeIMO.Reader.Xml 3.6.1

OfficeIMO.Reader.Xml - XML reader adapter

OfficeIMO.Reader.Xml provides a modular XML ingestion adapter for OfficeIMO.Reader.Core.

Install

dotnet add package OfficeIMO.Reader.Xml

Configure

using OfficeIMO.Reader;
using OfficeIMO.Reader.Xml;

OfficeDocumentReader reader = new OfficeDocumentReaderBuilder()
    .AddXmlHandler()
    .Build();

Examples

Convert XML elements and attributes into chunks

using OfficeIMO.Reader;
using OfficeIMO.Reader.Xml;

OfficeDocumentReader reader = new OfficeDocumentReaderBuilder()
    .AddXmlHandler(new XmlReadOptions {
        ChunkRows = 150,
        MaxDepth = 128,
        MaxNodes = 200_000,
        MaxScalarLength = 1_048_576,
        IncludeMarkdown = true
    })
    .Build();

foreach (var chunk in reader.Enumerate("configuration.xml")) {
    Console.WriteLine($"{chunk.Id}: {chunk.Location.Path}");
    Console.WriteLine(chunk.Markdown ?? chunk.Text);
}

Read XML from a bounded stream

using OfficeIMO.Reader;
using OfficeIMO.Reader.Xml;

OfficeDocumentReader reader = new OfficeDocumentReaderBuilder()
    .AddXmlHandler()
    .Build();

await using var stream = File.OpenRead("upload.xml");
var chunks = reader.Enumerate(stream, "upload.xml", new ReaderOptions {
    MaxInputBytes = 10L * 1024L * 1024L,
    MaxChars = 4_000
}).ToList();

What it emits

• XML tree traversal to element/attribute path rows.
• Chunked structured output with optional Markdown tables.
• Path and stream dispatch.
• Warning chunks for malformed XML.
• Complete scalar values within the configured parser limits.

The pull parser checks nesting, node count, and scalar length before building chunk output. The defaults accept 128 element levels, 200,000 XML nodes and attributes, and 1,048,576 characters per attribute or combined direct element text. Exceeding a parser limit throws ReaderResourceLimitException; it does not return a shortened value or a parse warning. Raise XmlReadOptions limits explicitly for trusted larger inputs. ReaderOptions.MaxInputBytes and aggregate ResourceLimits still apply independently.

Boundaries

• Reader adapter configuration belongs here.
• Shared extraction contracts belong in OfficeIMO.Reader.Core.

Targets and license

• Targets: netstandard2.0, net8.0, net10.0.
• License: MIT.

Dependency footprint

• External: None beyond platform XML APIs.
• OfficeIMO: OfficeIMO.Reader.Core owns traversal projection, chunking, limits, locations, and warnings.

See the complete OfficeIMO package map for related formats and conversion paths.