Skip to content

Commit c31ad3f

Browse files
committed
Add docstring
1 parent b6609e2 commit c31ad3f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

talpid-wireguard/src/lib.rs

+5
Original file line numberDiff line numberDiff line change
@@ -1003,6 +1003,11 @@ mod mtu_detection {
10031003

10041004
use super::Error;
10051005

1006+
/// Verify that the current MTU doesn't cause dropped packets, otherwise lower it to the
1007+
/// largest value which doesn't.
1008+
///
1009+
/// Note: This does not take fragmentation into account, so it should only be used as an extra
1010+
/// safety measure after the normal MTU calculation using header sizes and safety margins.
10061011
pub async fn automatic_mtu_correction(
10071012
gateway: std::net::Ipv4Addr,
10081013
iface_name_clone: String,

0 commit comments

Comments
 (0)