zig/wire_v2.zig

Página generada desde conduit@conduit-0.1.0-f7J_7zg5DwCsHBHItwdOz9ZVq8cvH7ceFsk7-m3-T61t (zig/root.zig). No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

conduit wire v2 — the codec of what v2 adds to v1 in mode chunks (spec/wire-v2.md §1, §4, §5.4, §10): the create body with "protocol":2, the v2 session/status/complete responses, the Conduit-Chunk-Cv header and the stored bitmap. Everything else (ids, routes, Content-Range, error bodies, the chunk response) is v1's, in wire.zig.

Negotiation (§1): a body or response without protocol is v1 and decodes exactly as wire.zig does; decode*Any return which one it was.

Same rules as wire.zig (styx dec-0117 B4/I5): exact lengths, lowercase hex only, overflow-checked integers, no unreachable on input, freestanding-clean. Mode blobs is parsed (so a server can refuse it precisely) but its manifest and blob routes are not here yet.

wire_v2.protocolCopiar enlace

const · línea 24

pub const protocol: u64 = 2

Sin ///.

wire_v2.chunk_cv_headerCopiar enlace

const · línea 26

pub const chunk_cv_header = "Conduit-Chunk-Cv"

Sin ///.

wire_v2.hex_cv_lenCopiar enlace

const · línea 27

pub const hex_cv_len = 64

Sin ///.

wire_v2.validChunkSizeCopiar enlace

fn · línea 35

pub fn validChunkSize(cs: u64) bool

chunkSize rule of v2 (§4.1): a power of two ≥ 16 KiB (and a JSON-safe integer), so every chunk is a subtree of the file's BLAKE3 tree.

wire_v2.parseCvCopiar enlace

fn · línea 40

pub fn parseCv(s: []const u8) ParseError!Cv

Conduit-Chunk-Cv / root / blobId: exactly 64 lowercase hex characters.

wire_v2.hexCvCopiar enlace

fn · línea 44

pub fn hexCv(cv: Cv) [hex_cv_len]u8

Sin ///.

wire_v2.bitmapLenCopiar enlace

fn · línea 52

pub fn bitmapLen(n: u64) u64

Sin ///.

wire_v2.writeBitmapCopiar enlace

fn · línea 58

pub fn writeBitmap(w: *Writer, n: u64, ctx: anytype, comptime isSet: fn (@TypeOf(ctx), u64) bool) Writer.Error!void

Base64 of the bitmap of n bits whose bit i is isSet(ctx, i), streamed three bytes at a time (no buffer proportional to n).

wire_v2.decodeBitmapCopiar enlace

fn · línea 79

pub fn decodeBitmap(arena: std.mem.Allocator, s: []const u8, n: u64) DecodeError![]u8

Bitmap bytes of n bits from canonical base64 (§5.4): exact length, padding, no spare bit set, canonical encoding. Allocated in arena.

wire_v2.bitIsSetCopiar enlace

fn · línea 96

pub fn bitIsSet(bitmap: []const u8, i: u64) bool

Sin ///.

wire_v2.ModeCopiar enlace

type · línea 102

pub const Mode = enum

Sin ///.

wire_v2.EncodingsCopiar enlace

type · línea 104

pub const Encodings = struct

Sin ///.

wire_v2.CreateV2Copiar enlace

type · línea 109

pub const CreateV2 = struct

Sin ///.

wire_v2.CreateCopiar enlace

type · línea 121

pub const Create = union

Sin ///.

wire_v2.decodeCreateAnyCopiar enlace

fn · línea 127

pub fn decodeCreateAny(arena: std.mem.Allocator, bytes: []const u8) DecodeError!Create

Server side: a create body of either protocol. Strings point into arena.

wire_v2.encodeCreateCopiar enlace

fn · línea 175

pub fn encodeCreate(w: *Writer, c: CreateV2) Writer.Error!void

Client side, byte-identical to the TS codec (vectors createSession.encode).

wire_v2.HaveCopiar enlace

type · línea 190

pub const Have = enum

Sin ///.

wire_v2.SessionV2Copiar enlace

type · línea 192

pub const SessionV2 = struct

Sin ///.

wire_v2.SessionCopiar enlace

type · línea 207

pub const Session = union

Sin ///.

wire_v2.encodeSessionCopiar enlace

fn · línea 212

pub fn encodeSession(w: *Writer, r: SessionV2) Writer.Error!void

Sin ///.

wire_v2.decodeSessionAnyCopiar enlace

fn · línea 230

pub fn decodeSessionAny(arena: std.mem.Allocator, bytes: []const u8) DecodeError!Session

Client side: the create response of either protocol (§1: no protocol field = the server spoke v1).

wire_v2.StatusV2Copiar enlace

type · línea 276

pub const StatusV2 = struct

Sin ///.

wire_v2.StatusCopiar enlace

type · línea 287

pub const Status = union

Sin ///.

wire_v2.encodeStatusCopiar enlace

fn · línea 293

pub fn encodeStatus(w: *Writer, id: wire.UploadId, mode: Mode, total: u64, confirmed: u64, status: wire.SessionStatus, ctx: anytype, comptime isSet: fn (@TypeOf(ctx), u64) bool) Writer.Error!void

Server side: status with the bitmap streamed from isSet(ctx, i).

wire_v2.decodeStatusAnyCopiar enlace

fn · línea 301

pub fn decodeStatusAny(arena: std.mem.Allocator, bytes: []const u8) DecodeError!Status

Sin ///.

wire_v2.encodeCompleteRequestCopiar enlace

fn · línea 323

pub fn encodeCompleteRequest(w: *Writer, root: Cv) Writer.Error!void

Sin ///.

wire_v2.decodeCompleteRequestCopiar enlace

fn · línea 329

pub fn decodeCompleteRequest(arena: std.mem.Allocator, bytes: []const u8) DecodeError!?Cv

Server side: optional body {"root":…}; empty body ⇒ null. A v1 sha256 in a v2 session is refused (one identity per session).

wire_v2.CompleteV2Copiar enlace

type · línea 338

pub const CompleteV2 = struct

Sin ///.

wire_v2.CompleteCopiar enlace

type · línea 345

pub const Complete = union

Sin ///.

wire_v2.encodeCompleteCopiar enlace

fn · línea 350

pub fn encodeComplete(w: *Writer, r: CompleteV2) Writer.Error!void

Sin ///.

wire_v2.decodeCompleteAnyCopiar enlace

fn · línea 358

pub fn decodeCompleteAny(arena: std.mem.Allocator, bytes: []const u8) DecodeError!Complete

Sin ///.

wire_v2.chunkHasherCopiar enlace

fn · línea 375

pub fn chunkHasher(plan: wire.Plan, index: u32) ?tree.SubtreeHasher

Range of chunk index of a v2 plan (wire.Plan with a valid v2 chunk size): an aligned subtree, the last one possibly shorter.