Zig 0.17.0-dev (Split by item) 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.
std › c › NOTE Public Constant NOTE Doc Source Public Constant std.c.NOTE
pub const NOTE = switch (native_os ) File c.zig: 10039
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313 pub const NOTE = switch (native_os ) {
.driverkit , .ios , .maccatalyst , .macos , .tvos , .visionos , .watchos => struct {
// https://github.com/apple-oss-distributions/xnu/blob/main/bsd/sys/event.h
/// On input, TRIGGER causes the event to be triggered for output.
pub const TRIGGER = 0x01000000 ;
/// ignore input fflags
pub const FFNOP = 0x00000000 ;
/// and fflags
pub const FFAND = 0x40000000 ;
/// or fflags
pub const FFOR = 0x80000000 ;
/// copy fflags
pub const FFCOPY = 0xc0000000 ;
/// mask for operations
pub const FFCTRLMASK = 0xc0000000 ;
pub const FFLAGSMASK = 0x00ffffff ;
/// low water mark
pub const LOWAT = 0x00000001 ;
/// OOB data
pub const OOB = 0x00000002 ;
/// vnode was removed
pub const DELETE = 0x00000001 ;
/// data contents changed
pub const WRITE = 0x00000002 ;
/// size increased
pub const EXTEND = 0x00000004 ;
/// attributes changed
pub const ATTRIB = 0x00000008 ;
/// link count changed
pub const LINK = 0x00000010 ;
/// vnode was renamed
pub const RENAME = 0x00000020 ;
/// vnode access was revoked
pub const REVOKE = 0x00000040 ;
/// No specific vnode event: to test for EVFILT_READ activation
pub const NONE = 0x00000080 ;
/// vnode was unlocked by flock(2)
pub const FUNLOCK = 0x00000100 ;
/// process exited
pub const EXIT = 0x80000000 ;
/// process forked
pub const FORK = 0x40000000 ;
/// process exec'd
pub const EXEC = 0x20000000 ;
/// shared with EVFILT_SIGNAL
pub const SIGNAL = 0x08000000 ;
/// exit status to be returned, valid for child process only
pub const EXITSTATUS = 0x04000000 ;
/// provide details on reasons for exit
pub const EXIT_DETAIL = 0x02000000 ;
/// mask for signal & exit status
pub const PDATAMASK = 0x000fffff ;
pub const PCTRLMASK = 0xf0000000 ;
pub const EXIT_DETAIL_MASK = 0x00070000 ;
pub const EXIT_DECRYPTFAIL = 0x00010000 ;
pub const EXIT_MEMORY = 0x00020000 ;
pub const EXIT_CSERROR = 0x00040000 ;
/// will react on memory pressure
pub const VM_PRESSURE = 0x80000000 ;
/// will quit on memory pressure, possibly after cleaning up dirty state
pub const VM_PRESSURE_TERMINATE = 0x40000000 ;
/// will quit immediately on memory pressure
pub const VM_PRESSURE_SUDDEN_TERMINATE = 0x20000000 ;
/// there was an error
pub const VM_ERROR = 0x10000000 ;
/// data is seconds
pub const SECONDS = 0x00000001 ;
/// data is microseconds
pub const USECONDS = 0x00000002 ;
/// data is nanoseconds
pub const NSECONDS = 0x00000004 ;
/// absolute timeout
pub const ABSOLUTE = 0x00000008 ;
/// ext[1] holds leeway for power aware timers
pub const LEEWAY = 0x00000010 ;
/// system does minimal timer coalescing
pub const CRITICAL = 0x00000020 ;
/// system does maximum timer coalescing
pub const BACKGROUND = 0x00000040 ;
/// with ABSOLUTE: causes the timer to continue to tick across sleep, still uses gettimeofday epoch
/// with MACHTIME and ABSOLUTE: uses mach continuous time epoch
/// without ABSOLUTE: continues to tick across sleep
pub const MACH_CONTINUOUS_TIME = 0x00000080 ;
/// data is mach absolute time units
pub const MACHTIME = 0x00000100 ;
},
.dragonfly => struct {
pub const FFNOP = 0 ;
pub const TRACK = 1 ;
pub const DELETE = 1 ;
pub const LOWAT = 1 ;
pub const TRACKERR = 2 ;
pub const OOB = 2 ;
pub const WRITE = 2 ;
pub const EXTEND = 4 ;
pub const CHILD = 4 ;
pub const ATTRIB = 8 ;
pub const LINK = 16 ;
pub const RENAME = 32 ;
pub const REVOKE = 64 ;
pub const PDATAMASK = 1048575 ;
pub const FFLAGSMASK = 16777215 ;
pub const TRIGGER = 16777216 ;
pub const EXEC = 536870912 ;
pub const FFAND = 1073741824 ;
pub const FORK = 1073741824 ;
pub const EXIT = 2147483648 ;
pub const FFOR = 2147483648 ;
pub const FFCTRLMASK = 3221225472 ;
pub const FFCOPY = 3221225472 ;
pub const PCTRLMASK = 4026531840 ;
},
.netbsd => struct {
/// ignore input fflags
pub const FFNOP = 0x00000000 ;
/// AND fflags
pub const FFAND = 0x40000000 ;
/// OR fflags
pub const FFOR = 0x80000000 ;
/// copy fflags
pub const FFCOPY = 0xc0000000 ;
/// masks for operations
pub const FFCTRLMASK = 0xc0000000 ;
pub const FFLAGSMASK = 0x00ffffff ;
/// On input, TRIGGER causes the event to be triggered for output.
pub const TRIGGER = 0x01000000 ;
/// low water mark
pub const LOWAT = 0x00000001 ;
/// vnode was removed
pub const DELETE = 0x00000001 ;
/// data contents changed
pub const WRITE = 0x00000002 ;
/// size increased
pub const EXTEND = 0x00000004 ;
/// attributes changed
pub const ATTRIB = 0x00000008 ;
/// link count changed
pub const LINK = 0x00000010 ;
/// vnode was renamed
pub const RENAME = 0x00000020 ;
/// vnode access was revoked
pub const REVOKE = 0x00000040 ;
/// vnode was opened
pub const OPEN = 0x00000080 ;
/// file closed (no FWRITE)
pub const CLOSE = 0x00000100 ;
/// file closed (FWRITE)
pub const CLOSE_WRITE = 0x00000200 ;
/// file was read
pub const READ = 0x00000400 ;
/// process exited
pub const EXIT = 0x80000000 ;
/// process forked
pub const FORK = 0x40000000 ;
/// process exec'd
pub const EXEC = 0x20000000 ;
/// mask for signal & exit status
pub const PDATAMASK = 0x000fffff ;
pub const PCTRLMASK = 0xf0000000 ;
/// follow across forks
pub const TRACK = 0x00000001 ;
/// could not track child
pub const TRACKERR = 0x00000002 ;
/// am a child process
pub const CHILD = 0x00000004 ;
/// shared with EVFILT_SIGNAL
pub const SIGNAL = 0x08000000 ;
/// data is milliseconds
pub const MSECONDS = 0x00000000 ;
/// data is seconds
pub const SECONDS = 0x00000001 ;
/// data is microseconds
pub const USECONDS = 0x00000002 ;
/// data is nanoseconds
pub const NSECONDS = 0x00000003 ;
/// timeout is absolute
pub const ABSTIME = 0x00000010 ;
},
.freebsd => struct {
/// On input, TRIGGER causes the event to be triggered for output.
pub const TRIGGER = 0x01000000 ;
/// ignore input fflags
pub const FFNOP = 0x00000000 ;
/// and fflags
pub const FFAND = 0x40000000 ;
/// or fflags
pub const FFOR = 0x80000000 ;
/// copy fflags
pub const FFCOPY = 0xc0000000 ;
/// mask for operations
pub const FFCTRLMASK = 0xc0000000 ;
pub const FFLAGSMASK = 0x00ffffff ;
/// low water mark
pub const LOWAT = 0x00000001 ;
/// behave like poll()
pub const FILE_POLL = 0x00000002 ;
/// vnode was removed
pub const DELETE = 0x00000001 ;
/// data contents changed
pub const WRITE = 0x00000002 ;
/// size increased
pub const EXTEND = 0x00000004 ;
/// attributes changed
pub const ATTRIB = 0x00000008 ;
/// link count changed
pub const LINK = 0x00000010 ;
/// vnode was renamed
pub const RENAME = 0x00000020 ;
/// vnode access was revoked
pub const REVOKE = 0x00000040 ;
/// vnode was opened
pub const OPEN = 0x00000080 ;
/// file closed, fd did not allow write
pub const CLOSE = 0x00000100 ;
/// file closed, fd did allow write
pub const CLOSE_WRITE = 0x00000200 ;
/// file was read
pub const READ = 0x00000400 ;
/// process exited
pub const EXIT = 0x80000000 ;
/// process forked
pub const FORK = 0x40000000 ;
/// process exec'd
pub const EXEC = 0x20000000 ;
/// mask for signal & exit status
pub const PDATAMASK = 0x000fffff ;
pub const PCTRLMASK = 0xf0000000 ;
/// data is seconds
pub const SECONDS = 0x00000001 ;
/// data is milliseconds
pub const MSECONDS = 0x00000002 ;
/// data is microseconds
pub const USECONDS = 0x00000004 ;
/// data is nanoseconds
pub const NSECONDS = 0x00000008 ;
/// timeout is absolute
pub const ABSTIME = 0x00000010 ;
},
.openbsd => struct {
// data/hint flags for EVFILT.{READ|WRITE}
pub const LOWAT = 0x0001 ;
pub const EOF = 0x0002 ;
// data/hint flags for EVFILT.EXCEPT and EVFILT.{READ|WRITE}
pub const OOB = 0x0004 ;
// data/hint flags for EVFILT.VNODE
pub const DELETE = 0x0001 ;
pub const WRITE = 0x0002 ;
pub const EXTEND = 0x0004 ;
pub const ATTRIB = 0x0008 ;
pub const LINK = 0x0010 ;
pub const RENAME = 0x0020 ;
pub const REVOKE = 0x0040 ;
pub const TRUNCATE = 0x0080 ;
// data/hint flags for EVFILT.PROC
pub const EXIT = 0x80000000 ;
pub const FORK = 0x40000000 ;
pub const EXEC = 0x20000000 ;
pub const PDATAMASK = 0x000fffff ;
pub const PCTRLMASK = 0xf0000000 ;
pub const TRACK = 0x00000001 ;
pub const TRACKERR = 0x00000002 ;
pub const CHILD = 0x00000004 ;
// data/hint flags for EVFILT.DEVICE
pub const CHANGE = 0x00000001 ;
// data/hint flags for EVFILT_USER
pub const FFNOP = 0x00000000 ;
pub const FFAND = 0x40000000 ;
pub const FFOR = 0x80000000 ;
pub const FFCOPY = 0xc0000000 ;
pub const FFCTRLMASK = 0xc0000000 ;
pub const FFLAGSMASK = 0x00ffffff ;
pub const TRIGGER = 0x01000000 ;
},
else => void ,
}