mirror of
https://github.com/ziglang/zig.git
synced 2024-11-16 00:57:04 +00:00
aa852f737b
A lot of these "shorthand" doc comments were redundant, low quality filler content. Better to let the actual modules speak for themselves with top level doc comments rather than trying to document their aliases.
173 lines
7.5 KiB
Zig
173 lines
7.5 KiB
Zig
pub const ArrayHashMap = array_hash_map.ArrayHashMap;
|
|
pub const ArrayHashMapUnmanaged = array_hash_map.ArrayHashMapUnmanaged;
|
|
pub const ArrayList = @import("array_list.zig").ArrayList;
|
|
pub const ArrayListAligned = @import("array_list.zig").ArrayListAligned;
|
|
pub const ArrayListAlignedUnmanaged = @import("array_list.zig").ArrayListAlignedUnmanaged;
|
|
pub const ArrayListUnmanaged = @import("array_list.zig").ArrayListUnmanaged;
|
|
pub const AutoArrayHashMap = array_hash_map.AutoArrayHashMap;
|
|
pub const AutoArrayHashMapUnmanaged = array_hash_map.AutoArrayHashMapUnmanaged;
|
|
pub const AutoHashMap = hash_map.AutoHashMap;
|
|
pub const AutoHashMapUnmanaged = hash_map.AutoHashMapUnmanaged;
|
|
pub const BitStack = @import("BitStack.zig");
|
|
pub const BoundedArray = @import("bounded_array.zig").BoundedArray;
|
|
pub const BoundedArrayAligned = @import("bounded_array.zig").BoundedArrayAligned;
|
|
pub const Build = @import("Build.zig");
|
|
pub const BufMap = @import("buf_map.zig").BufMap;
|
|
pub const BufSet = @import("buf_set.zig").BufSet;
|
|
/// Deprecated: use `process.Child`.
|
|
pub const ChildProcess = @import("child_process.zig").ChildProcess;
|
|
pub const ComptimeStringMap = comptime_string_map.ComptimeStringMap;
|
|
pub const ComptimeStringMapWithEql = comptime_string_map.ComptimeStringMapWithEql;
|
|
pub const DoublyLinkedList = @import("linked_list.zig").DoublyLinkedList;
|
|
pub const DynLib = @import("dynamic_library.zig").DynLib;
|
|
pub const DynamicBitSet = bit_set.DynamicBitSet;
|
|
pub const DynamicBitSetUnmanaged = bit_set.DynamicBitSetUnmanaged;
|
|
pub const EnumArray = enums.EnumArray;
|
|
pub const EnumMap = enums.EnumMap;
|
|
pub const EnumSet = enums.EnumSet;
|
|
pub const HashMap = hash_map.HashMap;
|
|
pub const HashMapUnmanaged = hash_map.HashMapUnmanaged;
|
|
pub const Ini = @import("Ini.zig");
|
|
pub const MultiArrayList = @import("multi_array_list.zig").MultiArrayList;
|
|
pub const PackedIntArray = @import("packed_int_array.zig").PackedIntArray;
|
|
pub const PackedIntArrayEndian = @import("packed_int_array.zig").PackedIntArrayEndian;
|
|
pub const PackedIntSlice = @import("packed_int_array.zig").PackedIntSlice;
|
|
pub const PackedIntSliceEndian = @import("packed_int_array.zig").PackedIntSliceEndian;
|
|
pub const PriorityQueue = @import("priority_queue.zig").PriorityQueue;
|
|
pub const PriorityDequeue = @import("priority_dequeue.zig").PriorityDequeue;
|
|
pub const Progress = @import("Progress.zig");
|
|
pub const Random = @import("Random.zig");
|
|
pub const RingBuffer = @import("RingBuffer.zig");
|
|
pub const SegmentedList = @import("segmented_list.zig").SegmentedList;
|
|
pub const SemanticVersion = @import("SemanticVersion.zig");
|
|
pub const SinglyLinkedList = @import("linked_list.zig").SinglyLinkedList;
|
|
pub const StaticBitSet = bit_set.StaticBitSet;
|
|
pub const StringHashMap = hash_map.StringHashMap;
|
|
pub const StringHashMapUnmanaged = hash_map.StringHashMapUnmanaged;
|
|
pub const StringArrayHashMap = array_hash_map.StringArrayHashMap;
|
|
pub const StringArrayHashMapUnmanaged = array_hash_map.StringArrayHashMapUnmanaged;
|
|
/// deprecated: use `DoublyLinkedList`.
|
|
pub const TailQueue = DoublyLinkedList;
|
|
pub const Target = @import("Target.zig");
|
|
pub const Thread = @import("Thread.zig");
|
|
pub const Treap = @import("treap.zig").Treap;
|
|
pub const Tz = tz.Tz;
|
|
pub const Uri = @import("Uri.zig");
|
|
|
|
pub const array_hash_map = @import("array_hash_map.zig");
|
|
pub const atomic = @import("atomic.zig");
|
|
pub const base64 = @import("base64.zig");
|
|
pub const bit_set = @import("bit_set.zig");
|
|
pub const builtin = @import("builtin.zig");
|
|
pub const c = @import("c.zig");
|
|
pub const coff = @import("coff.zig");
|
|
pub const compress = @import("compress.zig");
|
|
pub const comptime_string_map = @import("comptime_string_map.zig");
|
|
pub const crypto = @import("crypto.zig");
|
|
pub const debug = @import("debug.zig");
|
|
pub const dwarf = @import("dwarf.zig");
|
|
pub const elf = @import("elf.zig");
|
|
pub const enums = @import("enums.zig");
|
|
pub const fifo = @import("fifo.zig");
|
|
pub const fmt = @import("fmt.zig");
|
|
pub const fs = @import("fs.zig");
|
|
pub const gpu = @import("gpu.zig");
|
|
pub const hash = @import("hash.zig");
|
|
pub const hash_map = @import("hash_map.zig");
|
|
pub const heap = @import("heap.zig");
|
|
pub const http = @import("http.zig");
|
|
pub const io = @import("io.zig");
|
|
pub const json = @import("json.zig");
|
|
pub const leb = @import("leb128.zig");
|
|
pub const log = @import("log.zig");
|
|
pub const macho = @import("macho.zig");
|
|
pub const math = @import("math.zig");
|
|
pub const mem = @import("mem.zig");
|
|
pub const meta = @import("meta.zig");
|
|
pub const net = @import("net.zig");
|
|
pub const posix = @import("os.zig");
|
|
/// Non-portable Operating System-specific API.
|
|
pub const os = @import("os.zig");
|
|
pub const once = @import("once.zig").once;
|
|
pub const packed_int_array = @import("packed_int_array.zig");
|
|
pub const pdb = @import("pdb.zig");
|
|
pub const process = @import("process.zig");
|
|
/// Deprecated: use `Random` instead.
|
|
pub const rand = Random;
|
|
pub const sort = @import("sort.zig");
|
|
pub const simd = @import("simd.zig");
|
|
pub const ascii = @import("ascii.zig");
|
|
pub const tar = @import("tar.zig");
|
|
pub const testing = @import("testing.zig");
|
|
pub const time = @import("time.zig");
|
|
pub const tz = @import("tz.zig");
|
|
pub const unicode = @import("unicode.zig");
|
|
pub const valgrind = @import("valgrind.zig");
|
|
pub const wasm = @import("wasm.zig");
|
|
pub const zig = @import("zig.zig");
|
|
pub const start = @import("start.zig");
|
|
|
|
const root = @import("root");
|
|
|
|
/// Stdlib-wide options that can be overridden by the root file.
|
|
pub const options: Options = if (@hasDecl(root, "std_options")) root.std_options else .{};
|
|
|
|
pub const Options = struct {
|
|
enable_segfault_handler: bool = debug.default_enable_segfault_handler,
|
|
|
|
/// Function used to implement `std.fs.cwd` for WASI.
|
|
wasiCwd: fn () os.wasi.fd_t = fs.defaultWasiCwd,
|
|
|
|
/// The current log level.
|
|
log_level: log.Level = log.default_level,
|
|
|
|
log_scope_levels: []const log.ScopeLevel = &.{},
|
|
|
|
logFn: fn (
|
|
comptime message_level: log.Level,
|
|
comptime scope: @TypeOf(.enum_literal),
|
|
comptime format: []const u8,
|
|
args: anytype,
|
|
) void = log.defaultLog,
|
|
|
|
fmt_max_depth: usize = fmt.default_max_depth,
|
|
|
|
cryptoRandomSeed: fn (buffer: []u8) void = @import("crypto/tlcsprng.zig").defaultRandomSeed,
|
|
|
|
crypto_always_getrandom: bool = false,
|
|
|
|
crypto_fork_safety: bool = true,
|
|
|
|
/// By default Zig disables SIGPIPE by setting a "no-op" handler for it. Set this option
|
|
/// to `true` to prevent that.
|
|
///
|
|
/// Note that we use a "no-op" handler instead of SIG_IGN because it will not be inherited by
|
|
/// any child process.
|
|
///
|
|
/// SIGPIPE is triggered when a process attempts to write to a broken pipe. By default, SIGPIPE
|
|
/// will terminate the process instead of exiting. It doesn't trigger the panic handler so in many
|
|
/// cases it's unclear why the process was terminated. By capturing SIGPIPE instead, functions that
|
|
/// write to broken pipes will return the EPIPE error (error.BrokenPipe) and the program can handle
|
|
/// it like any other error.
|
|
keep_sigpipe: bool = false,
|
|
|
|
/// By default, std.http.Client will support HTTPS connections. Set this option to `true` to
|
|
/// disable TLS support.
|
|
///
|
|
/// This will likely reduce the size of the binary, but it will also make it impossible to
|
|
/// make a HTTPS connection.
|
|
http_disable_tls: bool = false,
|
|
|
|
side_channels_mitigations: crypto.SideChannelsMitigations = crypto.default_side_channels_mitigations,
|
|
};
|
|
|
|
// This forces the start.zig file to be imported, and the comptime logic inside that
|
|
// file decides whether to export any appropriate start symbols, and call main.
|
|
comptime {
|
|
_ = start;
|
|
}
|
|
|
|
test {
|
|
testing.refAllDecls(@This());
|
|
}
|