Csv Zig Reference Documentation

Csv

Current Version: 11.6.1

Chilkat.Csv

Read, edit, sort, and write CSV or delimiter-separated data in memory.

Chilkat.Csv is a practical in-memory table class for working with CSV and other delimiter-separated text formats. It can load CSV data from files or strings, access cells by row/column index or column name, manage header rows, insert and delete rows or columns, sort records, search for matching rows, and write the result back using configurable delimiters, quoting rules, character encodings, and line endings.

In-memory CSV table

Load CSV data, modify cells, add rows, delete rows or columns, and write the updated table back to a file or string.

Header and named columns

Use a header row to access fields by column name instead of only by numeric column index.

Cell and row operations

Read and update individual cells, insert columns, remove data, find matching rows, and sort the table as needed.

Delimiter control

Work with comma-separated data or other delimiter-separated formats by configuring the delimiter character.

Quoting and output formatting

Control quoted fields, forced quoting, output line endings, explicit character encodings, and UTF-8 BOM emission.

Excel worksheet loading

Load worksheet data from an opened .xlsx ZIP container when CSV-style access to spreadsheet content is needed.

Common pattern: Load CSV data, specify whether the first row is a header, access or modify cells by index or column name, perform any row, column, search, or sort operations, then save the table using the delimiter, charset, quoting, BOM, and line-ending settings required by the target system.

For an extended overview, see Csv Class Overview.

Object Creation

// Add the package once:
//     zig fetch --save https://chilkatdownload.com/11.6.1/chilkat-zig-11.6.1.tar.gz
// and in build.zig:
//     const chilkat = b.dependency("chilkat", .{ .target = target, .optimize = optimize });
//     exe.root_module.addImport("chilkat", chilkat.module("chilkat"));
const chilkat = @import("chilkat");

// Once per process, before any other Chilkat call:
try chilkat.unlockBundle("Anything for 30-day trial");

const csv = try chilkat.Csv.init();
defer csv.deinit();

pub fn init() Allocator.Error!Csv

Creates the underlying native Chilkat object. Csv is a one-pointer struct passed by value; copying it copies the handle (two names for one object). Returns error.OutOfMemory if the library could not allocate the object. Use an object from one thread at a time; it may be handed from one thread to another.

pub fn deinit(self: Csv) void

Releases the native object. Call it exactly once per object (usually with defer); the handle is invalid afterwards. Objects returned by methods are owned by the caller too and are released the same way.

pub fn fromHandle(h: *chilkat.c.CkCsv.HCkCsv) Csv

Wraps a handle obtained from the C API (chilkat.c.CkCsv), taking ownership of it. The struct's handle field goes the other way, for anything the Zig API does not cover.

Errors and memory

Methods that can fail return an error union: a method whose only outcome is success or failure returns Error!void; a method producing a string returns (Error || Allocator.Error)![:0]u8; a method producing an object returns Error!T. chilkat.Error is error{ChilkatFailed}; the reason for a failure is in getLastErrorText, and the object remains usable. Properties never fail, and methods that answer a question (hasMember, isUnlocked, ...) return a plain bool.

String arguments are [:0]const u8 (UTF-8; string literals can be passed as is). String results are copies allocated with the allocator argument and owned by the caller, so they stay valid across later calls on the same object.

const text = csv.someMethod(allocator, ...) catch |err| {
    const why = try csv.getLastErrorText(allocator);
    defer allocator.free(why);
    std.debug.print("{s}\n", .{why});
    return err;
};
defer allocator.free(text);

Properties

AutoTrim

// read/write
pub fn getAutoTrim(self: Csv) bool
pub fn setAutoTrim(self: Csv, value: bool) void

Controls whether leading and trailing whitespace is removed from values returned by GetCell and GetCellByName.

When true, surrounding whitespace such as spaces and tabs is removed from returned cell values.
When false, returned cell values are not trimmed. This is the default.

This property does not modify the cell contents stored in the CSV and does not change the text written by the save methods. It also does not trim the names returned by GetColumnName.

Csv Zig Reference Documentation

Csv

Current Version: 11.6.1

Read, edit, sort, and write CSV or delimiter-separated data in memory.

In-memory CSV table

Header and named columns

Cell and row operations

Delimiter control

Quoting and output formatting

Excel worksheet loading

Object Creation

Errors and memory

Properties

AutoTrim

Crlf

DebugLogFilePath

Delimiter

EnableQuotes

EscapeBackslash

HasColumnNames

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumColumns

NumRows

UncommonOptions

VerboseLogging

Version

XlsxDateFormat

Methods

DeleteColumn

DeleteColumnByName

DeleteRow

GetCell

GetCellByName

GetColumnName

GetIndex

GetNumCols

InsertColumn

LoadFile

LoadFile2

LoadFromString

RowMatches

SaveFile

SaveFile2

SaveToSb

SaveToString

SetCell

SetCellByName

SetColumnName

SortByColumn

SortByColumnIndex

XlsxGetSheets

XlsxLoadSheet