跳转到内容
标准库Zig 0.17.1官方原文
源码std/zon.zig

第 1 行

ZON 解析与字符串化。

ZON(“Zig Object Notation”,Zig 对象表示法)是一种文本文件格式。除 nan 和 inf 字面量外,ZON 语法是 Zig 语法的子集。

支持的 Zig 原始类型:

  • 布尔字面量
  • 数值字面量,包括 nan 和 inf
  • 字符字面量
  • 枚举字面量
  • null 字面量
  • 字符串字面量
  • 多行字符串字面量

支持的 Zig 容器类型:

  • 匿名结构体字面量
  • 匿名元组字面量

ZON 对象示例:

.{
    .a = 1.5,
    .b = "hello, world!",
    .c = .{ true, false },
    .d = .{ 1, 2, 3 },
    .e = .{ .x = 13, .y = 67 },
}

单个原始值也是有效的 ZON,例如:

"This string is a valid ZON object."

ZON 不能包含类型名称。

ZON 没有指针语法,但解析器会按需分配内存,以匹配给定的 Zig 类型。同样,序列化器会遍历指针。

std.zon.fmt

函数

第 47 行

返回使用 stringify 格式化给定值的格式化器。

pub fn fmt(value: anytype, options: stringify.SerializeOptions) Formatter(@TypeOf(value))

参数

用法示例

test fmt {
    const expectFmt = std.testing.expectFmt;
    try expectFmt("123", "{f}", .{fmt(@as(u32, 123), .{})});
    try expectFmt(
        \\.{
        \\    .num = 927,
        \\    .msg = "hello",
        \\    .sub = .{ .mybool = true },
        \\}
    , "{f}", .{fmt(struct {
        num: u32,
        msg: []const u8,
        sub: struct {
            mybool: bool,
        },
    }{
        .num = 927,
        .msg = "hello",
        .sub = .{ .mybool = true },
    }, .{})});
}

std.zon.Formatter

类型函数

第 74 行

使用 stringify 格式化给定值。

pub fn Formatter(comptime T: type) type

参数

T: type

字段

value: T
options: stringify.SerializeOptions

std.zon.Formatter.format

函数

第 79 行

pub fn format(self: @This(), writer: *std.Io.Writer) std.Io.Writer.Error!void

参数

self: @This()
writer: *std.Io.Writer

错误

WriteFailed

详细诊断信息见 Writer 实现。

std.zon.parse

别名

第 42 行

别名目标 std.zon.parse

std.zon.Serializer

别名

第 44 行

别名目标 std.zon.Serializer

std.zon.std

别名

第 40 行

别名目标 std

std.zon.stringify

别名

第 43 行

别名目标 std.zon.stringify

源码

std/zon.zig

//! ZON 解析与字符串化。
//!
//! ZON(“Zig Object Notation”,Zig 对象表示法)是一种文本文件格式。除 `nan` 和 `inf` 字面量外,ZON 语法是 Zig 语法的子集。
//!
//! 支持的 Zig 原始类型:
//! * 布尔字面量
//! * 数值字面量,包括 `nan` 和 `inf`
//! * 字符字面量
//! * 枚举字面量
//! * `null` 字面量
//! * 字符串字面量
//! * 多行字符串字面量
//!
//! 支持的 Zig 容器类型:
//! * 匿名结构体字面量
//! * 匿名元组字面量
//!
//! ZON 对象示例:
//! ```
//! .{
//!     .a = 1.5,
//!     .b = "hello, world!",
//!     .c = .{ true, false },
//!     .d = .{ 1, 2, 3 },
//!     .e = .{ .x = 13, .y = 67 },
//! }
//! ```
//!
//! 单个原始值也是有效的 ZON,例如:
//! ```
//! "This string is a valid ZON object."
//! ```
//!
//! ZON 不能包含类型名称。
//!
//! ZON 没有指针语法,但解析器会按需分配内存,以匹配给定的 Zig 类型。同样,序列化器会遍历指针。
//!
//!

const std = @import("std");

pub const parse = @import("zon/parse.zig");
pub const stringify = @import("zon/stringify.zig");
pub const Serializer = @import("zon/Serializer.zig");

/// 返回使用 stringify 格式化给定值的格式化器。
pub fn fmt(value: anytype, options: stringify.SerializeOptions) Formatter(@TypeOf(value)) {
    return Formatter(@TypeOf(value)){ .value = value, .options = options };
}

test fmt {
    const expectFmt = std.testing.expectFmt;
    try expectFmt("123", "{f}", .{fmt(@as(u32, 123), .{})});
    try expectFmt(
        \\.{
        \\    .num = 927,
        \\    .msg = "hello",
        \\    .sub = .{ .mybool = true },
        \\}
    , "{f}", .{fmt(struct {
        num: u32,
        msg: []const u8,
        sub: struct {
            mybool: bool,
        },
    }{
        .num = 927,
        .msg = "hello",
        .sub = .{ .mybool = true },
    }, .{})});
}

/// 使用 stringify 格式化给定值。
pub fn Formatter(comptime T: type) type {
    return struct {
        value: T,
        options: stringify.SerializeOptions,

        pub fn format(self: @This(), writer: *std.Io.Writer) std.Io.Writer.Error!void {
            try stringify.serialize(self.value, self.options, writer);
        }
    };
}

test {
    _ = parse;
    _ = stringify;
}