Trait embedded_nal::Dns

source ·
pub trait Dns {
    type Error: Debug;

    // Required methods
    fn get_host_by_name(
        &mut self,
        hostname: &str,
        addr_type: AddrType
    ) -> Result<IpAddr, Self::Error>;
    fn get_host_by_address(
        &self,
        addr: IpAddr,
        result: &mut [u8]
    ) -> Result<usize, Self::Error>;
}
Expand description

This trait is an extension trait for TcpStack and UdpStack for dns resolutions. It does not handle every DNS record type, but is meant as an embedded alternative to ToSocketAddrs, and is as such meant to resolve an ip address from a hostname, or a hostname from an ip address. This means that it only deals in host address records A (IPv4) and AAAA (IPv6).

Required Associated Types§

source

type Error: Debug

The type returned when we have an error

Required Methods§

source

fn get_host_by_name( &mut self, hostname: &str, addr_type: AddrType ) -> Result<IpAddr, Self::Error>

Resolve the first ip address of a host, given its hostname and a desired address record type to look for

source

fn get_host_by_address( &self, addr: IpAddr, result: &mut [u8] ) -> Result<usize, Self::Error>

Resolve the hostname of a host, given its ip address.

The hostname is stored at the beginning of result, the length is returned.

If the buffer is too small to hold the domain name, an error should be returned.

Note: A fully qualified domain name (FQDN), has a maximum length of 255 bytes according to rfc1035. Therefore, you can pass a 255-byte long buffer to guarantee it’ll always be large enough.

Implementations on Foreign Types§

source§

impl<T: Dns> Dns for &mut T

§

type Error = <T as Dns>::Error

source§

fn get_host_by_name( &mut self, hostname: &str, addr_type: AddrType ) -> Result<IpAddr, Self::Error>

source§

fn get_host_by_address( &self, addr: IpAddr, result: &mut [u8] ) -> Result<usize, Self::Error>

Implementors§