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 Struct

Flags

Public Struct
std.Io.net.IncomingMessage.Flags
pub const Flags = packed struct(u8)

Fields

eor: bool

indicates end-of-record; the data returned completed a record (generally used with sockets of type SOCK_SEQPACKET).

trunc: bool

indicates that the trailing portion of a datagram was discarded because the datagram was larger than the buffer supplied.

ctrunc: bool

indicates that some control data was discarded due to lack of space in the buffer for ancil‐ lary data.

oob: bool

indicates expedited or out-of-band data was received.

errqueue: bool

indicates that no data was received but an extended error from the socket error queue.

_: u3 = 0

File

Io/net.zig:946
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
    pub const Flags = packed struct(u8) {
        /// indicates end-of-record; the data returned completed a record
        /// (generally used with sockets of type SOCK_SEQPACKET).
        eor: bool,
        /// indicates that the trailing portion of a datagram was discarded
        /// because the datagram was larger than the buffer supplied.
        trunc: bool,
        /// indicates that some control data was discarded due to lack of
        /// space in the buffer for ancil‐ lary data.
        ctrunc: bool,
        /// indicates expedited or out-of-band data was received.
        oob: bool,
        /// indicates that no data was received but an extended error from the
        /// socket error queue.
        errqueue: bool,
        _: u3 = 0,
    }