Skip to content

Commit 8a2059a

Browse files
AtsushiSakaiKristofferC
authored andcommitted
add docstring for Sockets.DNSError (#34189)
1 parent 0d9d6ae commit 8a2059a

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

stdlib/Sockets/docs/src/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Sockets.getaddrinfo
1010
Sockets.getipaddr
1111
Sockets.getipaddrs
1212
Sockets.getalladdrinfo
13+
Sockets.DNSError
1314
Sockets.getnameinfo
1415
Sockets.getsockname
1516
Sockets.getpeername

stdlib/Sockets/src/addrinfo.jl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# This file is a part of Julia. License is MIT: https://julialang.org/license
22

3+
"""
4+
DNSError
5+
6+
The type of exception thrown when an error occurs in DNS lookup.
7+
The `host` field indicates the host URL string.
8+
The `code` field indicates the error code based on libuv.
9+
"""
310
struct DNSError <: Exception
411
host::String
512
code::Int32

0 commit comments

Comments
 (0)