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 Function

parse

Public Function
std.Io.net.Ip6Address.parse
pub fn parse(buffer: []const u8, port: u16) ParseError!Ip6Address

This is a pure function but it cannot handle IPv6 addresses that have scope ids ("%foo" at the end). To also handle those, resolve must be called instead, or the lower level Unresolved API may be used.

Params

  • buffer: []const u8
  • port: u16

File

Io/net.zig:682
682
683
684
685
686
687
688
689
690
691
692
    pub fn parse(buffer: []const u8, port: u16) ParseError!Ip6Address {
        switch (Unresolved.parse(buffer)) {
            .success => |p| return .{
                .bytes = p.bytes,
                .port = port,
                .interface = if (p.interface_name != null) return error.UnresolvedScope else .none,
            },
            else => return error.ParseFailed,
        }
        return .{ .ip6 = try Ip6Address.parse(buffer, port) };
    }