From 546db20934e97afab8b6b2b1029eaaeb2cb5ac73 Mon Sep 17 00:00:00 2001 From: lesnyrumcajs Date: Thu, 7 Feb 2019 22:42:02 +0100 Subject: [PATCH] added panic doc --- src/lib.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index e0a676c..68bb0e3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -41,6 +41,8 @@ impl WolPacket { /// extern crate wakey; /// let wol = wakey::WolPacket::from_string("00:01:02:03:04:05", ':'); /// ``` + /// # Panic + /// Panics when input MAC is invalid (i.e. contains non-byte characters) pub fn from_string(data: &str, sep: char) -> WolPacket { WolPacket::from_bytes(&WolPacket::mac_to_byte(data, sep)) } @@ -80,6 +82,7 @@ impl WolPacket { } /// Converts string representation of MAC address (e.x. 00:01:02:03:04:05) to raw bytes. + /// # Panic /// Panics when input MAC is invalid (i.e. contains non-byte characters) fn mac_to_byte(data: &str, sep: char) -> Vec { data.split(sep)