tiny.zen.document

Defined in tiny.zen.

API (12)

Types and contracts

Public types and contracts.

• Capacity
• CapacityError
• Document: Borrowed view of the headings held by active Storage.
• Error: All heading inspection failures, including checked-capacity overflow.
• Exhaustion: Rejections produced before heading storage is acquired or changed.
• Heading: One source heading copied into caller-owned storage.
• Limits: Maximum heading descriptors and copied text and ID bytes.
• Plan: Exact storage demand measured from one source without allocation.
• Status: Observable capacity, current demand, high-water demand, and rejections.
• Storage: One reusable aligned region for an inspected Markdown document.

Values and defaults

Public values and defaults.

• default_capacity
• default_limits: General-purpose limits for convenience Markdown rendering.

Source

Source: lib/zen/src/document/root.zig

1const capacity_mod = @import("capacity.zig");2const model = @import("model.zig");3const plan_mod = @import("plan.zig");4const storage_mod = @import("storage.zig");56pub const Heading = model.Heading;7pub const Document = model.Document;8pub const Limits = plan_mod.Limits;9pub const default_limits = plan_mod.default_limits;10pub const Plan = plan_mod.Plan;11pub const Capacity = capacity_mod.Capacity;12pub const CapacityError = capacity_mod.DeriveError;13pub const default_capacity = Capacity.derive(default_limits) catch unreachable;14pub const Storage = storage_mod.Storage;15pub const Status = storage_mod.Status;16pub const Exhaustion = model.Exhaustion;17pub const Error = model.Error;

Source: lib/zen/src/root.zig:19

1/// Bounded heading plans, storage, and borrowed document views.2pub const document = @import("document/root.zig");

Audit