neon/net

pub type Posix {
  Eaddrinuse
  Eaddrnotavail
  Eafnosupport
  Ealready
  Econnaborted
  Econnrefused
  Econnreset
  Edestaddrreq
  Ehostdown
  Ehostunreach
  Einprogress
  Eisconn
  Emsgsize
  Enetdown
  Enetreset
  Enetunreach
  Enopkg
  Enoprotoopt
  Enotconn
  Enotty
  Enotsock
  Eproto
  Eprotonosupport
  Eprototype
  Esocktnosupport
  Etimedout
  Ewouldblock
  Exbadport
  Exbadseq
  Nxdomain
  Eacces
  Eagain
  Ebadf
  Ebadmsg
  Ebusy
  Edeadlk
  Edeadlock
  Edquot
  Eexist
  Efault
  Efbig
  Eftype
  Eintr
  Einval
  Eio
  Eisdir
  Eloop
  Emfile
  Emlink
  Emultihop
  Enametoolong
  Enfile
  Enobufs
  Enodev
  Enolck
  Enolink
  Enoent
  Enomem
  Enospc
  Enosr
  Enostr
  Enosys
  Enotblk
  Enotdir
  Enotsup
  Enxio
  Eopnotsupp
  Eoverflow
  Eperm
  Epipe
  Erange
  Erofs
  Eshutdown
  Espipe
  Esrch
  Estale
  Etxtbsy
  Exdev
}

Constructors

```
Eaddrinuse
```
```
Eaddrnotavail
```
```
Eafnosupport
```
```
Ealready
```
```
Econnaborted
```
```
Econnrefused
```
```
Econnreset
```
```
Edestaddrreq
```
```
Ehostdown
```
```
Ehostunreach
```
```
Einprogress
```
```
Eisconn
```
```
Emsgsize
```
```
Enetdown
```
```
Enetreset
```
```
Enetunreach
```
```
Enopkg
```
```
Enoprotoopt
```
```
Enotconn
```
```
Enotty
```
```
Enotsock
```
```
Eproto
```
```
Eprotonosupport
```
```
Eprototype
```
```
Esocktnosupport
```
```
Etimedout
```
```
Ewouldblock
```
```
Exbadport
```
```
Exbadseq
```
```
Nxdomain
```
```
Eacces
```
```
Eagain
```
```
Ebadf
```
```
Ebadmsg
```
```
Ebusy
```
```
Edeadlk
```
```
Edeadlock
```
```
Edquot
```
```
Eexist
```
```
Efault
```
```
Efbig
```
```
Eftype
```
```
Eintr
```
```
Einval
```
```
Eio
```
```
Eisdir
```
```
Eloop
```
```
Emfile
```
```
Emlink
```
```
Emultihop
```
```
Enametoolong
```
```
Enfile
```
```
Enobufs
```
```
Enodev
```
```
Enolck
```
```
Enolink
```
```
Enoent
```
```
Enomem
```
```
Enospc
```
```
Enosr
```
```
Enostr
```
```
Enosys
```
```
Enotblk
```
```
Enotdir
```
```
Enotsup
```
```
Enxio
```
```
Eopnotsupp
```
```
Eoverflow
```
```
Eperm
```
```
Epipe
```
```
Erange
```
```
Erofs
```
```
Eshutdown
```
```
Espipe
```
```
Esrch
```
```
Estale
```
```
Etxtbsy
```
```
Exdev
```

Timeout

opaque </>

A timeout value for socket operations.

This type is opaque. Use timeout to create a finite timeout or infinity for no timeout.

pub opaque type Timeout

Values

hostname

</>

pub fn hostname(name: String) -> Address

Creates an address from a hostname string.

infinity

</>

pub const infinity: Timeout

An infinite timeout.

ip_address

</>

pub fn ip_address(addr: IpAddress) -> Address

Creates an address from an IP address.

ip_address_to_string

</>

pub fn ip_address_to_string(address: IpAddress) -> String

Converts an IP address to its string representation.

ip_address_version

</>

pub fn ip_address_version(address: IpAddress) -> IpVersion

Returns the IP version of an IP address.

ipv4_address

</>

pub fn ipv4_address(
  a: Int,
  b: Int,
  c: Int,
  d: Int,
) -> Result(IpAddress, Nil)

Creates an IPv4 address from four octets.

Each octet must be in the range 0-255. Returns Error(Nil) if any octet is out of range.

ipv6_address

</>

pub fn ipv6_address(
  a: Int,
  b: Int,
  c: Int,
  d: Int,
  e: Int,
  f: Int,
  g: Int,
  h: Int,
) -> Result(IpAddress, Nil)

Creates an IPv6 address from eight 16-bit groups.

Each group must be in the range 0-65535. Returns Error(Nil) if any group is out of range.

// The loopback address ::1
let assert Ok(addr) = ipv6_address(0, 0, 0, 0, 0, 0, 0, 1)

// fe80::1 (link-local)
let assert Ok(addr) = ipv6_address(0xfe80, 0, 0, 0, 0, 0, 0, 1)

// 2001:db8::1 (documentation range)
let assert Ok(addr) = ipv6_address(0x2001, 0x0db8, 0, 0, 0, 0, 0, 1)

parse_ip_address

</>

pub fn parse_ip_address(
  address: String,
) -> Result(IpAddress, Posix)

Parses a string as an IP address.

Accepts both IPv4 (e.g. "127.0.0.1") and IPv6 (e.g. "::1") formats.

port

</>

pub fn port(num: Int) -> Result(Port, Nil)

Creates a port from an integer.

The value must be in the range 0-65535. Returns Error(Nil) if the value is out of range.

port_to_int

</>

pub fn port_to_int(port: Port) -> Int

Returns the integer value of a port.

posix_to_string

</>

pub fn posix_to_string(code: Posix) -> String

Converts a POSIX error code to its string representation.

timeout

</>

pub fn timeout(num: Int) -> Result(Timeout, Nil)

Creates a timeout from a number of milliseconds.

The value must be non-negative. Returns Error(Nil) if the value is negative.