max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

net: document crate.

Browse Source
This commit is contained in:
Dario Nieuwenhuis
2023-05-15 00:39:57 +02:00
parent 62857bdb2d
commit d07821d851
5 changed files with 160 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
embassy-net/src/dns.rs
View File

@@ -1,4 +1,9 @@
//! DNS socket with async support.
//! DNS client compatible with the `embedded-nal-async` traits.
//!
//! This exists only for compatibility with crates that use `embedded-nal-async`.
//! Prefer using [`Stack::dns_query`](crate::Stack::dns_query) directly if you're
//! not using `embedded-nal-async`.
use heapless::Vec;
pub use smoltcp::socket::dns::{DnsQuery, Socket};
pub(crate) use smoltcp::socket::dns::{GetQueryResultError, StartQueryError};
@@ -34,7 +39,11 @@ impl From<StartQueryError> for Error {
}
}
/// Async socket for making DNS queries.
/// DNS client compatible with the `embedded-nal-async` traits.
///
/// This exists only for compatibility with crates that use `embedded-nal-async`.
/// Prefer using [`Stack::dns_query`](crate::Stack::dns_query) directly if you're
/// not using `embedded-nal-async`.
pub struct DnsSocket<'a, D>
where
D: Driver + 'static,