Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Namespace

no_panic

Public Namespace

This namespace can be used with pub const panic = std.debug.no_panic; in the root file. It emits as little code as possible, for testing purposes.

For a functional alternative, see std.debug.FullPanic.

Namespaces

Functions

pub fn call(_: []const u8, _: ?usize) noreturn
pub fn sentinelMismatch(_: anytype, _: anytype) noreturn
pub fn unwrapError(_: anyerror) noreturn
pub fn outOfBounds(_: usize, _: usize) noreturn
pub fn startGreaterThanEnd(_: usize, _: usize) noreturn
pub fn inactiveUnionField(_: anytype, _: anytype) noreturn
pub fn sliceCastLenRemainder(_: usize) noreturn
pub fn reachedUnreachable() noreturn
pub fn unwrapNull() noreturn
pub fn castToNull() noreturn
pub fn incorrectAlignment() noreturn
pub fn invalidErrorCode() noreturn
pub fn unexpectedErrorCode(_: anyerror) noreturn
pub fn integerOutOfBounds() noreturn
pub fn integerOverflow() noreturn
pub fn shlOverflow() noreturn
pub fn shrOverflow() noreturn
pub fn divideByZero() noreturn
pub fn exactDivisionRemainder() noreturn
pub fn integerPartOutOfBounds() noreturn
pub fn corruptSwitch() noreturn
pub fn shiftRhsTooBig() noreturn
pub fn invalidEnumValue() noreturn
pub fn forLenMismatch() noreturn
pub fn copyLenMismatch() noreturn
pub fn memcpyAlias() noreturn
pub fn noreturnReturned() noreturn
pub fn loadUninstantiableType() noreturn

File

debug/no_panic.zig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
//! This namespace can be used with `pub const panic = std.debug.no_panic;` in the root file.
//! It emits as little code as possible, for testing purposes.
//!
//! For a functional alternative, see `std.debug.FullPanic`.

const std = @import("../std.zig");

pub fn call(_: []const u8, _: ?usize) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn sentinelMismatch(_: anytype, _: anytype) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn unwrapError(_: anyerror) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn outOfBounds(_: usize, _: usize) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn startGreaterThanEnd(_: usize, _: usize) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn inactiveUnionField(_: anytype, _: anytype) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn sliceCastLenRemainder(_: usize) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn reachedUnreachable() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn unwrapNull() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn castToNull() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn incorrectAlignment() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn invalidErrorCode() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn unexpectedErrorCode(_: anyerror) noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn integerOutOfBounds() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn integerOverflow() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn shlOverflow() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn shrOverflow() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn divideByZero() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn exactDivisionRemainder() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn integerPartOutOfBounds() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn corruptSwitch() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn shiftRhsTooBig() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn invalidEnumValue() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn forLenMismatch() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn copyLenMismatch() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn memcpyAlias() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn noreturnReturned() noreturn {
    @branchHint(.cold);
    @trap();
}

pub fn loadUninstantiableType() noreturn {
    @branchHint(.cold);
    @trap();
}