IO Streaming#47
Merged
Merged
Conversation
…ancing memory efficiency
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added IO streaming for large documents.
Resolves #30
This pull request introduces streaming IO support to the Markdown parser and all built-in renderers, allowing efficient handling of large documents and direct output to any writer (such as files, sockets, or stdout) without intermediate allocation. It also fixes memory safety issues with dangling slices in the AST, improves documentation and usage examples, and updates performance benchmarks.
Streaming IO and Renderer API Enhancements:
All six built-in renderers (
HTMLRenderer,ASTRenderer,AIRenderer,TerminalRenderer,MarkdownRenderer,TypstRenderer) now support arenderToWriter(Allocator, *std.Io.Writer, AST.Document)method for zero-allocation, streaming output. TheRendererinterface and documentation are updated accordingly. (README.md,CHANGELOG.md,src/main.zig,src/markdown/renderers/*.zig, [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]The parser now exposes
parseFromReader(*std.Io.Reader), enabling parsing directly from streams (files, stdin, pipes, sockets) without requiring the entire input in memory. The returned AST is fully self-contained. (README.md,CHANGELOG.md,src/markdown/parser.zig, [1] [2] [3] [4]Memory Safety and Bug Fixes:
FencedCodeBlock.languageandFootnoteDefinition.labelby ensuring these fields are owned allocations, properly freed in their respectivedeinitmethods. (CHANGELOG.md,src/markdown/ast.zig,src/markdown/parser.zig, [1] [2] [3] [4] [5]Documentation and Examples:
README.md, README.mdR428-R466)Performance Benchmarks:
README.md, README.mdL669-L718)Changelog and Versioning:
CHANGELOG.md, [1] [2]