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

BindOptions

Public Struct
std.Io.net.IpAddress.BindOptions
pub const BindOptions = struct

Fields

ip6_only: ?bool = null

The socket is restricted to sending and receiving IPv6 packets only. In this case, an IPv4 and an IPv6 application can bind to a single port at the same time.

The default is determined by system configuration.

allow_broadcast: bool = false

Allow the socket to send datagrams to broadcast addresses. When not enabled any attempt to send datagrams to a broadcast address will fail with error.AccessDenied

mode: Socket.Mode
protocol: ?Protocol = null

File

Io/net.zig:284
284
285
286
287
288
289
290
291
292
293
294
295
296
297
    pub const BindOptions = struct {
        /// The socket is restricted to sending and receiving IPv6 packets only.
        /// In this case, an IPv4 and an IPv6 application can bind to a single port
        /// at the same time.
        ///
        /// The default is determined by system configuration.
        ip6_only: ?bool = null,
        /// Allow the socket to send datagrams to broadcast addresses.
        /// When not enabled any attempt to send datagrams to a broadcast address
        /// will fail with `error.AccessDenied`
        allow_broadcast: bool = false,
        mode: Socket.Mode,
        protocol: ?Protocol = null,
    }