API
#netIP/port parsing, TCP/UDP IPv4/IPv6 and Unix sockets on Unix; Windows TCP remains limited.
struct HostPortpub struct HostPort {
pub host string
pub port string
}net — `net` correspondence. IP values are owning strings of raw bytes (len 4 = IPv4, len 16 = IPv6). Stream I/O covers TCP IPv4/IPv6 and Unix pathname sockets on Darwin/Linux. UDP IPv4/IPv6 and DNS-over-TCP live in sibling files; raw IP remains stubbed. fd-level dial/listen/accept/conn_* stay for net/http and net/smtp.
host stringport stringnew_host_portpub fn new_host_port() HostPortConstruct host port.
none
HostPort — a value of this type
(HostPort) hostpub fn (hp HostPort) host() stringMethod on `HostPort`: host.
hp HostPortstring — result string
(HostPort) portpub fn (hp HostPort) port() stringMethod on `HostPort`: port.
hp HostPortstring — result string
ipv4pub fn ipv4(a int, b int, c int, d int) stringBuild an IPv4 address from four 0..255 octets (a 4-byte string).
a intb intc intd intstring — result string
parse_ippub fn parse_ip(s &string) stringParse as ip.
s &stringstring — result string
ip_stringpub fn ip_string(ip &string) stringIP string.
ip &stringstring — result string
ip_is_unspecifiedpub fn ip_is_unspecified(ip &string) boolWhether ip is unspecified.
ip &stringbool — true or false
ip_is_loopbackpub fn ip_is_loopback(ip &string) boolWhether ip is loopback.
ip &stringbool — true or false
ip_is_privatepub fn ip_is_private(ip &string) boolWhether ip is private.
ip &stringbool — true or false
join_host_portpub fn join_host_port(host &string, port &string) stringJoin host port.
host &stringport &stringstring — result string
(&mut HostPort) splitpub fn (hp &mut HostPort) split(hostport string) intMethod on `&mut HostPort`: split on the separator. Throws on failure.
hp &mut HostPorthostport stringint — a value of this type
struct Connpub struct Conn {
pub network string
pub laddr string
pub raddr string
pub read_deadline_ns int
pub write_deadline_ns int
}TCP IPv4 runtime wrappers + Conn/Listener methods
network stringladdr stringraddr stringread_deadline_ns intwrite_deadline_ns intstruct Listenerpub struct Listener {
pub network string
pub addr string
}Public struct `Listener`.
network stringaddr stringdialpub fn dial(addr string) intDial a connection.
addr stringint — a value of this type
dial_nspub fn dial_ns(addr string, ns int) intdial_ns is the fd-level connect with an optional SO_SNDTIMEO bound. ns <= 0 means no extra timeout (same as dial). Throws on failure.
addr stringns intint — a value of this type
listenpub fn listen(addr string) intListen for connections. Throws on failure.
addr stringint — a value of this type
acceptpub fn accept(fd int) intAccept one connection. Throws on failure.
fd intint — a value of this type
conn_closepub fn conn_close(fd int) intConnection close. Throws on failure.
fd intint — a value of this type
conn_writepub fn conn_write(fd int, data &string) intConnection write. Throws on failure.
fd intdata &stringint — a value of this type
conn_readpub fn conn_read(fd int, max int) stringConnection read. Throws on failure.
fd intmax intstring — result string
(&mut Conn) set_deadlinepub fn (c &mut Conn) set_deadline(t_ns int) intConn.SetDeadline / SetReadDeadline / SetWriteDeadline. t_ns is absolute now_ns; 0 clears. Remaining time is applied as SO_RCVTIMEO/SO_SNDTIMEO before the next read/write so an in-flight syscall can return; 0 does not clear an already-armed kernel timeout until the next I/O path that sees t_ns==0 (set_deadline(0) does).
c &mut Connt_ns intint — a value of this type
(&mut Conn) set_read_deadlinepub fn (c &mut Conn) set_read_deadline(t_ns int) intMethod on `&mut Conn`: set read deadline.
c &mut Connt_ns intint — a value of this type
(&mut Conn) set_write_deadlinepub fn (c &mut Conn) set_write_deadline(t_ns int) intMethod on `&mut Conn`: set write deadline.
c &mut Connt_ns intint — a value of this type
(&Conn) readpub fn (c &Conn) read(max int) stringMethod on `&Conn`: read up to max bytes. Throws on failure.
c &Connmax intstring — result string
(&Conn) writepub fn (c &Conn) write(data &string) intMethod on `&Conn`: write data and return the byte count. Throws on failure.
c &Conndata &stringint — bytes written
(&mut Conn) closepub fn (c &mut Conn) close() intMethod on `&mut Conn`: close the resource. Throws on failure.
c &mut Connint — a value of this type
(Conn) local_addrpub fn (c Conn) local_addr() stringMethod on `Conn`: local address.
c Connstring — result string
(Conn) remote_addrpub fn (c Conn) remote_addr() stringMethod on `Conn`: remote address.
c Connstring — result string
(Listener) acceptpub fn (l Listener) accept() ConnMethod on `Listener`: accept one connection. Throws on failure.
l ListenerConn — a value of this type
(&mut Listener) closepub fn (l &mut Listener) close() intMethod on `&mut Listener`: close the resource. Throws on failure.
l &mut Listenerint — a value of this type
(Listener) addrpub fn (l Listener) addr() stringMethod on `Listener`: address.
l Listenerstring — result string
file_connpub fn file_conn(fd int) ConnFile connection. Throws on failure.
fd intConn — a value of this type
file_listenerpub fn file_listener(fd int) ListenerFile listener. Throws on failure.
fd intListener — a value of this type
closed_connpub fn closed_conn() ConnClosed connection.
none
Conn — a value of this type
(&Conn) is_closedpub fn (c &Conn) is_closed() boolMethod on `&Conn`: whether it is closed.
c &Connbool — true or false
(&Conn) descriptorpub fn (c &Conn) descriptor() intBorrowed raw descriptor; platform adapters must not create a second owner. Throws on failure.
c &Connint — a value of this type
struct TCPAddrpub struct TCPAddr {
pub ip string
pub port int
pub zone string
}Addr types ( TCPAddr / UDPAddr / IPAddr / UnixAddr) plus SplitHostPort as a value-returning helper. IP fields are raw-byte strings.
ip stringport intzone stringstruct UDPAddrpub struct UDPAddr {
pub ip string
pub port int
pub zone string
}Public struct `UDPAddr`.
ip stringport intzone stringstruct IPAddrpub struct IPAddr {
pub ip string
pub zone string
}Public struct `IPAddr`.
ip stringzone stringstruct UnixAddrpub struct UnixAddr {
pub name string
pub network string
}Public struct `UnixAddr`.
name stringnetwork stringnew_tcp_addrpub fn new_tcp_addr() TCPAddrConstruct tcp addr.
none
TCPAddr — a value of this type
new_udp_addrpub fn new_udp_addr() UDPAddrConstruct udp addr.
none
UDPAddr — a value of this type
new_ip_addrpub fn new_ip_addr() IPAddrConstruct ip addr.
none
IPAddr — a value of this type
new_unix_addrpub fn new_unix_addr() UnixAddrConstruct unix addr.
none
UnixAddr — a value of this type
(TCPAddr) networkpub fn (a TCPAddr) network() stringCall `network` on `TCPAddr`.
a TCPAddrstring — result string
(UDPAddr) networkpub fn (a UDPAddr) network() stringCall `network` on `UDPAddr`.
a UDPAddrstring — result string
(IPAddr) networkpub fn (a IPAddr) network() stringCall `network` on `IPAddr`.
a IPAddrstring — result string
(UnixAddr) networkpub fn (a UnixAddr) network() stringCall `network` on `UnixAddr`.
a UnixAddrstring — result string
(TCPAddr) to_stringpub fn (a TCPAddr) to_string() stringMethod on `TCPAddr`: convert to string.
a TCPAddrstring — result string
(&UDPAddr) clonepub fn (a &UDPAddr) clone() UDPAddrMethod on `&UDPAddr`: copy into a new independent string.
a &UDPAddrUDPAddr — a value of this type
(UDPAddr) to_stringpub fn (a UDPAddr) to_string() stringMethod on `UDPAddr`: convert to string.
a UDPAddrstring — result string
(IPAddr) to_stringpub fn (a IPAddr) to_string() stringMethod on `IPAddr`: convert to string.
a IPAddrstring — result string
(UnixAddr) to_stringpub fn (a UnixAddr) to_string() stringMethod on `UnixAddr`: convert to string.
a UnixAddrstring — result string
split_host_portpub fn split_host_port(hostport string) HostPortSplit host port. Throws on failure.
hostport stringHostPort — a value of this type
resolve_tcp_addrpub fn resolve_tcp_addr(network string, address string) TCPAddrResolve TCP address. Throws on failure.
network stringaddress stringTCPAddr — a value of this type
resolve_udp_addrpub fn resolve_udp_addr(network string, address string) UDPAddrResolve UDP address. Throws on failure.
network stringaddress stringUDPAddr — a value of this type
resolve_ip_addrpub fn resolve_ip_addr(network string, address string) IPAddrResolve IP address. Throws on failure.
network stringaddress stringIPAddr — a value of this type
resolve_unix_addrpub fn resolve_unix_addr(network string, address string) UnixAddrResolve unix address. Throws on failure.
network stringaddress stringUnixAddr — a value of this type
struct Dialerpub struct Dialer {
pub timeout_ns int
pub dual_stack bool
pub local_ip string
pub local_port int
}Dialer / ListenConfig and -shaped Dial/Listen (network, address). Context is for Dial/Listen ( DialContext / ListenConfig.Listen), not for Conn.Read/Write — those use SetDeadline like. The fd-level dial(addr)/listen(addr) in mod.xu stay for http/smtp.
timeout_ns intdual_stack boollocal_ip stringlocal_port intstruct ListenConfigpub struct ListenConfig {
pub reuse bool
}Public struct `ListenConfig`.
reuse boolnew_dialerpub fn new_dialer() DialerConstruct dialer.
none
Dialer — a value of this type
new_listen_configpub fn new_listen_config() ListenConfigConstruct listen config.
none
ListenConfig — a value of this type
dial_tcppub fn dial_tcp(network string, laddr TCPAddr, raddr TCPAddr) ConnDial TCP. Throws on failure.
network stringladdr TCPAddrraddr TCPAddrConn — a value of this type
listen_tcppub fn listen_tcp(network string, laddr TCPAddr) ListenerListen TCP. Throws on failure.
network stringladdr TCPAddrListener — a value of this type
dial_topub fn dial_to(network string, address string) ConnDial to. Throws on failure.
network stringaddress stringConn — a value of this type
listen_onpub fn listen_on(network string, address string) ListenerListen on. Throws on failure.
network stringaddress stringListener — a value of this type
dial_contextpub fn dial_context(ctx &context.Context, network string, address string) Conndial_context is net.DialContext.
ctx &context.Contextnetwork stringaddress stringConn — a value of this type
(Dialer) dialpub fn (d Dialer) dial(network string, address string) ConnMethod on `Dialer`: dial a connection. Throws on failure.
d Dialernetwork stringaddress stringConn — a value of this type
(Dialer) dial_contextpub fn (d Dialer) dial_context(ctx &context.Context, network string, address string) ConnMethod on `Dialer`: dial context. Throws on failure.
d Dialerctx &context.Contextnetwork stringaddress stringConn — a value of this type
dial_timeoutpub fn dial_timeout(network string, address string, timeout_ns int) ConnDial timeout. Throws on failure.
network stringaddress stringtimeout_ns intConn — a value of this type
(ListenConfig) listenpub fn (c ListenConfig) listen(ctx &context.Context, network string, address string) Listenerlisten is ListenConfig.Listen(ctx, network, address). Throws on failure.
c ListenConfigctx &context.Contextnetwork stringaddress stringListener — a value of this type
listen_packetpub fn listen_packet(network string, address string) PacketConnListen packet. Throws on failure.
network stringaddress stringPacketConn — a value of this type
struct Interfacepub struct Interface {
pub index int
pub mtu int
pub name string
pub hardware_addr string
pub flags int
}Public struct `Interface`.
index intmtu intname stringhardware_addr stringflags intnew_interfacepub fn new_interface() InterfaceConstruct interface.
none
Interface — a value of this type
flags_stringpub fn flags_string(f int) stringFlags string.
f intstring — result string
(Interface) addrspub fn (ifi Interface) addrs() []stringCall `addrs` on `Interface`. Throws on failure.
ifi Interface[]string — slice result
interfacespub fn interfaces() []InterfaceInterfaces. Throws on failure.
none
[]Interface — slice result
interface_addrspub fn interface_addrs() []stringInterface addrs. Throws on failure.
none
[]string — slice result
interface_by_namepub fn interface_by_name(name string) InterfaceInterface by name. Throws on failure.
name stringInterface — a value of this type
interface_by_indexpub fn interface_by_index(index int) InterfaceInterface by index. Throws on failure.
index intInterface — a value of this type
struct IPNetpub struct IPNet {
pub ip string
pub mask string
}Public struct `IPNet`.
ip stringmask stringstruct CIDRpub struct CIDR {
pub ip string
pub ipnet IPNet
}Public struct `CIDR`.
ip stringipnet IPNetipv4_zeropub fn ipv4_zero() stringIPv4 zero.
none
string — result string
ipv4_bcastpub fn ipv4_bcast() stringIPv4 bcast.
none
string — result string
ipv4_allsyspub fn ipv4_allsys() stringIPv4 allsys.
none
string — result string
ipv4_allrouterpub fn ipv4_allrouter() stringIPv4 allrouter.
none
string — result string
ipv6_zeropub fn ipv6_zero() stringIPv6 zero.
none
string — result string
ipv6_unspecifiedpub fn ipv6_unspecified() stringIPv6 unspecified.
none
string — result string
ipv6_loopbackpub fn ipv6_loopback() stringIPv6 loopback.
none
string — result string
ipv6_interface_local_all_nodespub fn ipv6_interface_local_all_nodes() stringIPv6 interface local all nodes.
none
string — result string
ipv6_link_local_all_nodespub fn ipv6_link_local_all_nodes() stringIPv6 link local all nodes.
none
string — result string
ipv6_link_local_all_routerspub fn ipv6_link_local_all_routers() stringIPv6 link local all routers.
none
string — result string
ipv4_maskpub fn ipv4_mask(a int, b int, c int, d int) stringIPv4 mask.
a intb intc intd intstring — result string
cidr_maskpub fn cidr_mask(ones int, bits int) stringCidr mask.
ones intbits intstring — result string
ip_to4pub fn ip_to4(ip &string) stringIP to4.
ip &stringstring — result string
ip_to16pub fn ip_to16(ip &string) stringIP to16.
ip &stringstring — result string
ip_equalpub fn ip_equal(a &string, b &string) boolIP equal.
a &stringb &stringbool — true or false
ip_maskpub fn ip_mask(ip &string, mask &string) stringIP mask.
ip &stringmask &stringstring — result string
ip_default_maskpub fn ip_default_mask(ip &string) stringIP default mask.
ip &stringstring — result string
ip_mask_sizepub fn ip_mask_size(mask &string) intIP mask size.
mask &stringint — a value of this type
ip_mask_bitspub fn ip_mask_bits(mask &string) intIP mask bits.
mask &stringint — a value of this type
ip_mask_stringpub fn ip_mask_string(mask &string) stringIP mask string.
mask &stringstring — result string
(IPNet) networkpub fn (n IPNet) network() stringCall `network` on `IPNet`.
n IPNetstring — result string
(IPNet) containspub fn (n IPNet) contains(ip &string) boolMethod on `IPNet`: report whether the input contains the given piece.
n IPNetip &stringbool — true or false
(IPNet) to_stringpub fn (n IPNet) to_string() stringMethod on `IPNet`: convert to string.
n IPNetstring — result string
parse_cidrpub fn parse_cidr(s &string) CIDRParse as cidr. Throws on failure.
s &stringCIDR — a value of this type
ip_is_multicastpub fn ip_is_multicast(ip &string) boolWhether ip is multicast.
ip &stringbool — true or false
ip_is_interface_local_multicastpub fn ip_is_interface_local_multicast(ip &string) boolWhether ip is interface_local_multicast.
ip &stringbool — true or false
ip_is_link_local_multicastpub fn ip_is_link_local_multicast(ip &string) boolWhether ip is link_local_multicast.
ip &stringbool — true or false
ip_is_link_local_unicastpub fn ip_is_link_local_unicast(ip &string) boolWhether ip is link_local_unicast.
ip &stringbool — true or false
ip_is_global_unicastpub fn ip_is_global_unicast(ip &string) boolWhether ip is global_unicast.
ip &stringbool — true or false
dial_ippub fn dial_ip(network string, laddr IPAddr, raddr IPAddr) ConnRaw IP sockets ( IPConn). ResolveIPAddr works; DialIP/ListenIP wait on SOCK_RAW runtime support. Throws on failure.
network stringladdr IPAddrraddr IPAddrConn — a value of this type
listen_ippub fn listen_ip(network string, laddr IPAddr) PacketConnListen IP. Throws on failure.
network stringladdr IPAddrPacketConn — a value of this type
struct MXpub struct MX {
pub host string
pub pref int
}Name lookup ( net/lookup.): numeric / localhost / hosts / DNS-over-TCP.
host stringpref intstruct NSpub struct NS {
pub host string
}Public struct `NS`.
host stringstruct SRVpub struct SRV {
pub target string
pub port int
pub priority int
pub weight int
}Public struct `SRV`.
target stringport intpriority intweight intlookup_hostpub fn lookup_host(host string) []stringLookup host. Throws on failure.
host string[]string — slice result
lookup_ippub fn lookup_ip(host string) []stringLookup IP. Throws on failure.
host string[]string — slice result
lookup_cnamepub fn lookup_cname(host string) stringLookup cname. Throws on failure.
host stringstring — result string
lookup_mxpub fn lookup_mx(name string) []MXLookup mx.
name string[]MX — slice result
lookup_nspub fn lookup_ns(name string) []NSLookup ns.
name string[]NS — slice result
lookup_txtpub fn lookup_txt(name string) []stringLookup txt.
name string[]string — slice result
lookup_srvpub fn lookup_srv(service string, proto string, name string) []SRVLookup srv. Throws on failure.
service stringproto stringname string[]SRV — slice result
lookup_addrpub fn lookup_addr(addr string) []stringLookup address. Throws on failure.
addr string[]string — slice result
hardware_addr_stringpub fn hardware_addr_string(a &string) stringHardwareAddr ( net/mac.). Raw bytes as an owning string; parse_mac accepts MAC-48 / EUI-48 / EUI-64 / 20-octet InfiniBand forms.
a &stringstring — result string
parse_macpub fn parse_mac(s &string) stringParse as mac. Throws on failure.
s &stringstring — result string
struct PipeConnpub struct PipeConn {
pub w chan string
pub r chan string
pub closed int
}In-memory full-duplex pipe ( net.Pipe). Ends are channel-backed PipeConn values, not socket fds.
w chan stringr chan stringclosed intstruct PipePairpub struct PipePair {
pub c1 PipeConn
pub c2 PipeConn
}Public struct `PipePair`.
c1 PipeConnc2 PipeConnpipepub fn pipe() PipePairpipe; returns PipePair.
none
PipePair — a value of this type
(PipeConn) readpub fn (c PipeConn) read() stringMethod on `PipeConn`: read up to max bytes. Throws on failure.
c PipeConnstring — result string
(PipeConn) writepub fn (c PipeConn) write(data string) intMethod on `PipeConn`: write data and return the byte count. Throws on failure.
c PipeConndata stringint — bytes written
(&mut PipeConn) closepub fn (c &mut PipeConn) close() intMethod on `&mut PipeConn`: close the resource.
c &mut PipeConnint — a value of this type
(PipeConn) local_addrpub fn (c PipeConn) local_addr() stringMethod on `PipeConn`: local address.
c PipeConnstring — result string
(PipeConn) remote_addrpub fn (c PipeConn) remote_addr() stringMethod on `PipeConn`: remote address.
c PipeConnstring — result string
(PipeConn) networkpub fn (c PipeConn) network() stringCall `network` on `PipeConn`.
c PipeConnstring — result string
lookup_portpub fn lookup_port(network string, service string) intLookup port. Throws on failure.
network stringservice stringint — a value of this type
lookup_protocolpub fn lookup_protocol(name string) intLookup protocol. Throws on failure.
name stringint — a value of this type
(&Conn) read_resultpub fn (c &Conn) read_result(n int) io.ReadResultMethod on `&Conn`: read result.
c &Connn intio.ReadResult — a value of this type
(&Conn) write_resultpub fn (c &Conn) write_result(data string) io.WriteResultMethod on `&Conn`: write result.
c &Conndata stringio.WriteResult — a value of this type
(&Conn) read_npub fn (c &Conn) read_n(n int) stringio stream adapters preserve the existing per-connection deadline behavior. Throws on failure.
c &Connn intstring — result string
(&Conn) write_strpub fn (c &Conn) write_str(data string) intMethod on `&Conn`: write a string. Throws on failure.
c &Conndata stringint — a value of this type
struct PacketConnpub struct PacketConn {
pub network string
pub laddr string
pub raddr string
}UDP types ( UDPConn / PacketConn). Datagram I/O is IPv4; socket/bind
network stringladdr stringraddr stringstruct UDPPacketpub struct UDPPacket {
pub addr UDPAddr
pub data string
}Public struct `UDPPacket`.
addr UDPAddrdata string(PacketConn) local_addrpub fn (c PacketConn) local_addr() stringMethod on `PacketConn`: local address.
c PacketConnstring — result string
(PacketConn) remote_addrpub fn (c PacketConn) remote_addr() stringMethod on `PacketConn`: remote address.
c PacketConnstring — result string
(&PacketConn) readpub fn (c &PacketConn) read(max int) stringConnected packet I/O uses socket recv/send so the Windows path reaches Winsock rather than the file-handle WriteFile/ReadFile helpers. Throws on failure.
c &PacketConnmax intstring — result string
(&PacketConn) writepub fn (c &PacketConn) write(data &string) intMethod on `&PacketConn`: write data and return the byte count. Throws on failure.
c &PacketConndata &stringint — bytes written
(PacketConn) read_frompub fn (c PacketConn) read_from(max int) UDPPacketMethod on `PacketConn`: read from. Throws on failure.
c PacketConnmax intUDPPacket — a value of this type
(PacketConn) write_topub fn (c PacketConn) write_to(data &string, addr &UDPAddr) intMethod on `PacketConn`: write to. Throws on failure.
c PacketConndata &stringaddr &UDPAddrint — a value of this type
(&mut PacketConn) closepub fn (c &mut PacketConn) close() intMethod on `&mut PacketConn`: close the resource. Throws on failure.
c &mut PacketConnint — a value of this type
dial_udppub fn dial_udp(network string, laddr UDPAddr, raddr UDPAddr) PacketConnDial UDP. Throws on failure.
network stringladdr UDPAddrraddr UDPAddrPacketConn — a value of this type
listen_udppub fn listen_udp(network string, laddr UDPAddr) PacketConnListen UDP. Throws on failure.
network stringladdr UDPAddrPacketConn — a value of this type
dial_unixpub fn dial_unix(network string, laddr UnixAddr, raddr UnixAddr) ConnDial unix. Throws on failure.
network stringladdr UnixAddrraddr UnixAddrConn — a value of this type
listen_unixpub fn listen_unix(network string, laddr UnixAddr) ListenerListen unix. Throws on failure.
network stringladdr UnixAddrListener — a value of this type