tiny.syn.span

Defined in tiny.syn.

The namespace holds what a scan produces: the marked byte ranges of a line, the buffer that receives them, and the arithmetic that sizes that buffer.

API (11)

Types and contracts

Public types and contracts.

• Capacity: The sizes that follow from one Limits value, computed without allocating.
• DeriveError: The one way sizing can fail.
• Kind: The role of the text one span covers.
• Limits: The one limit the caller chooses for span storage.
• Materialization: What happened to the spans of one line.
• Span: One marked byte range of a line and its role.
• Status: A caller reads it from Storage.status to check sizes and to count dropped lines, as the README example and the tests do.
• Storage: A caller creates one before scanning and passes it to every highlight and highlightLine call.

Namespaces

Public namespaces.

• capacity: The arithmetic computes, from one limit the caller chooses, how many bytes the storage for a line's marks needs.
• model: A scan produces marked byte ranges for one line, each with the role of the text it covers, and whether the marks of the line were kept.
• storage: The buffer that receives the marks of each line: one region, allocated when the buffer is created, freed when it is destroyed, and reused for every line in between.

Source

Source: lib/syn/src/root.zig:39

1pub const span = @import("span/root.zig");

Source: lib/syn/src/span/root.zig

1//! The namespace holds what a scan produces: the marked byte ranges of a line, the buffer that2//! receives them, and the arithmetic that sizes that buffer. A caller needs to know before it scans3//! anything how much memory the marks of its longest line take, and then needs the marks of each4//! line in a buffer it can read.5//!6//! Each marked range (*span*) carries its role with it, as a start byte, an end byte and a kind, so7//! a renderer picks colors without scanning again. The buffer (*span storage*) is allocated once8//! from a limit on line length, and every later line reuses it.9pub const capacity = @import("capacity.zig");10pub const model = @import("model.zig");11pub const storage = @import("storage.zig");1213pub const Capacity = capacity.Capacity;14pub const Limits = capacity.Limits;15pub const DeriveError = capacity.DeriveError;16pub const Kind = model.Kind;17pub const Materialization = model.Materialization;18pub const Span = model.Span;19pub const Status = storage.Status;20pub const Storage = storage.Storage;

Audit