NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

net: Add documentation to new Config system

Browse source
This commit is contained in:
Ruben De Smet 2023-06-07 12:08:53 +02:00
parent 352f0b6c38
commit 2455fd4dbe
No known key found for this signature in database
GPG key ID: 1AE26A210C14115B
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
embassy-net/src/lib.rs
View file

@ -128,13 +128,16 @@ impl Default for DhcpConfig {
/// Network stack configuration. /// Network stack configuration.
pub struct Config { pub struct Config {
/// IPv4 configuration
#[cfg(feature = "proto-ipv4")] #[cfg(feature = "proto-ipv4")]
pub ipv4: ConfigV4, pub ipv4: ConfigV4,
/// IPv6 configuration
#[cfg(feature = "proto-ipv6")] #[cfg(feature = "proto-ipv6")]
pub ipv6: ConfigV6, pub ipv6: ConfigV6,
} }
impl Config { impl Config {
/// IPv4 configuration with static addressing.
#[cfg(feature = "proto-ipv4")] #[cfg(feature = "proto-ipv4")]
pub fn ipv4_static(config: StaticConfigV4) -> Self { pub fn ipv4_static(config: StaticConfigV4) -> Self {
Self { Self {
@ -144,6 +147,7 @@ impl Config {
} }
} }
/// IPv6 configuration with static addressing.
#[cfg(feature = "proto-ipv6")] #[cfg(feature = "proto-ipv6")]
pub fn ipv6_static(config: StaticConfigV6) -> Self { pub fn ipv6_static(config: StaticConfigV6) -> Self {
Self { Self {
@ -153,6 +157,12 @@ impl Config {
} }
} }
/// IPv6 configuration with dynamic addressing.
///
/// # Example
/// ```rust
/// let _cfg = Config::dhcpv4(Default::default());
/// ```
#[cfg(feature = "dhcpv4")] #[cfg(feature = "dhcpv4")]
pub fn dhcpv4(config: DhcpConfig) -> Self { pub fn dhcpv4(config: DhcpConfig) -> Self {
Self { Self {