ensure_root_privileges

README.md

@@ -54,7 +54,7 @@ fn main() {
     #[cfg(target_os = "linux")]
     config.platform_config(|config| {
         config.packet_information(true);
-        config.ask_permission(true);
+        config.ensure_root_privileges(true);
     });
 
     let mut dev = tun2::create(&config).unwrap();

examples/ping-tun.rs

@@ -44,7 +44,7 @@ async fn main_entry(
     #[cfg(target_os = "linux")]
     config.platform_config(|config| {
         config.packet_information(true);
-        config.ask_permission(true);
+        config.ensure_root_privileges(true);
     });
 
     #[cfg(target_os = "windows")]

examples/read-async.rs

@@ -44,7 +44,7 @@ async fn main_entry(
     #[cfg(target_os = "linux")]
     config.platform_config(|config| {
         config.packet_information(true);
-        config.ask_permission(true);
+        config.ensure_root_privileges(true);
     });
 
     let mut dev = tun2::create_as_async(&config)?;

examples/read.rs

@@ -41,7 +41,7 @@ fn main_entry(quit: Receiver<()>) -> Result<(), Box<dyn std::error::Error + Send
     #[cfg(target_os = "linux")]
     config.platform_config(|config| {
         config.packet_information(true);
-        config.ask_permission(true);
+        config.ensure_root_privileges(true);
     });
 
     let mut dev = tun2::create(&config)?;

examples/split.rs

@@ -42,7 +42,7 @@ fn main_entry(quit: Receiver<()>) -> Result<(), Box<dyn std::error::Error + Send
     #[cfg(target_os = "linux")]
     config.platform_config(|config| {
         config.packet_information(true);
-        config.ask_permission(true);
+        config.ensure_root_privileges(true);
     });
 
     let dev = tun2::create(&config)?;

examples/write.rs

@@ -42,7 +42,7 @@ fn main_entry(quit: Receiver<()>) -> Result<(), Box<dyn std::error::Error + Send
     #[cfg(target_os = "linux")]
     config.platform_config(|config| {
         config.packet_information(true);
-        config.ask_permission(true);
+        config.ensure_root_privileges(true);
     });
 
     let mut dev = tun2::create(&config)?;

src/platform/linux/device.rs

@@ -121,7 +121,7 @@ impl Device {
             }
         };
 
-        if config.platform_config.ask_permission {
+        if config.platform_config.ensure_root_privileges {
             device.configure(config)?;
         }
 

src/platform/linux/mod.rs

@@ -28,14 +28,14 @@ pub struct PlatformConfig {
     /// switch of Enable/Disable packet information for network driver
     pub(crate) packet_information: bool,
     /// root privileges required or not
-    pub(crate) ask_permission: bool,
+    pub(crate) ensure_root_privileges: bool,
 }
 
 impl Default for PlatformConfig {
     fn default() -> Self {
         PlatformConfig {
             packet_information: false,
-            ask_permission: true,
+            ensure_root_privileges: true,
         }
     }
 }
@@ -48,10 +48,10 @@ impl PlatformConfig {
         self
     }
 
-    /// Indicated if tun2 running in root privilege,
+    /// Indicated whether tun2 running in root privilege,
     /// since some operations need it such as assigning IP/netmask/destination etc.
-    pub fn ask_permission(&mut self, value: bool) -> &mut Self {
-        self.ask_permission = value;
+    pub fn ensure_root_privileges(&mut self, value: bool) -> &mut Self {
+        self.ensure_root_privileges = value;
         self
     }
 }