embedded-nal 0.4.0

A Network Abstraction Layer (NAL) for Embedded Systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

use heapless::{consts, String};
use no_std_net::IpAddr;

/// This is the host address type to be returned by `gethostbyname`.
///
/// An IPv4 address type always looks for `A` records, while IPv6 address type
/// will look for `AAAA` records
#[derive(Clone, Debug, PartialEq)]
pub enum AddrType {
	/// Result is `A` record
	IPv4,
	/// Result is `AAAA` record
	IPv6,
	/// Result is either a `A` record, or a `AAAA` record
	Either,
}

/// 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).
///
/// [`TcpStack`]: crate::trait@TcpStack
/// [`UdpStack`]: crate::trait@UdpStack
/// [`ToSocketAddrs`]:
/// https://doc.rust-lang.org/std/net/trait.ToSocketAddrs.html
pub trait Dns {
	/// The type returned when we have an error
	type Error: core::fmt::Debug;

	/// Resolve the first ip address of a host, given its hostname and a desired
	/// address record type to look for
	fn get_host_by_name(
		&self,
		hostname: &str,
		addr_type: AddrType,
	) -> nb::Result<IpAddr, Self::Error>;

	/// Resolve the hostname of a host, given its ip address
	///
	/// **Note**: A fully qualified domain name (FQDN), has a maximum length of
	/// 255 bytes [`rfc1035`]
	///
	/// [`rfc1035`]: https://tools.ietf.org/html/rfc1035
	fn get_host_by_address(&self, addr: IpAddr) -> nb::Result<String<consts::U256>, Self::Error>;
}