New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Hex Strings #234
Merged
Merged
Hex Strings #234
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
67bf7ea
remove hand-rolled hex encoding
lthiery b835da9
implement to string for more types
lthiery 2912c17
impl from str
lthiery 77ef338
no need to feature-gate from_str
lthiery e30f83b
clean up header
lthiery 52bf04c
implement FromStr
lthiery 503ce10
improve documentation
lthiery 9ed7ef8
redraft docs again
lthiery 20c5690
test wrong lengths
lthiery 474ad7d
one more pass at docs
lthiery File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,5 +9,3 @@ | |
pub extern crate std; | ||
|
||
pub mod hasher; | ||
#[cfg(feature = "with-to-string")] | ||
pub mod to_string; |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,180 @@ | ||
use crate::keys::*; | ||
use crate::parser::*; | ||
|
||
#[cfg(feature = "with-to-string")] | ||
pub extern crate std; | ||
|
||
pub use hex::FromHexError; | ||
|
||
macro_rules! fixed_len_struct_impl_to_string_msb { | ||
( | ||
$type:ident,$size:expr; | ||
) => { | ||
impl core::str::FromStr for $type { | ||
type Err = FromHexError; | ||
|
||
fn from_str(s: &str) -> Result<Self, Self::Err> { | ||
let mut res = [0; $size]; | ||
hex::decode_to_slice(s.as_bytes(), &mut res)?; | ||
Ok(Self::from(res)) | ||
} | ||
} | ||
|
||
#[cfg(feature = "with-to-string")] | ||
impl std::string::ToString for $type { | ||
fn to_string(&self) -> std::string::String { | ||
let mut res = std::string::String::with_capacity($size * 2); | ||
res.extend(std::iter::repeat('-').take($size * 2)); | ||
let slice = unsafe { &mut res.as_bytes_mut() }; | ||
hex::encode_to_slice(self.as_ref(), slice).unwrap(); | ||
res | ||
} | ||
} | ||
}; | ||
( | ||
$type:ident[$size:expr]; | ||
) => { | ||
impl core::str::FromStr for $type<[u8; $size]> { | ||
type Err = FromHexError; | ||
|
||
fn from_str(s: &str) -> Result<Self, Self::Err> { | ||
let mut res = [0; $size]; | ||
hex::decode_to_slice(s.as_bytes(), &mut res)?; | ||
Ok(Self::from(res)) | ||
} | ||
} | ||
|
||
#[cfg(feature = "with-to-string")] | ||
impl<T: AsRef<[u8]>> std::string::ToString for $type<T> { | ||
fn to_string(&self) -> std::string::String { | ||
let mut res = std::string::String::with_capacity($size * 2); | ||
res.extend(std::iter::repeat('-').take($size * 2)); | ||
let slice = unsafe { &mut res.as_bytes_mut() }; | ||
hex::encode_to_slice(self.as_ref(), slice).unwrap(); | ||
res | ||
} | ||
} | ||
}; | ||
} | ||
|
||
macro_rules! fixed_len_struct_impl_string_lsb { | ||
( | ||
$type:ident,$size:expr; | ||
) => { | ||
impl core::str::FromStr for $type { | ||
type Err = FromHexError; | ||
|
||
fn from_str(s: &str) -> Result<Self, Self::Err> { | ||
let mut res = [0; $size]; | ||
hex::decode_to_slice(s.as_bytes(), &mut res)?; | ||
res.reverse(); | ||
Ok(Self::from(res)) | ||
} | ||
} | ||
|
||
#[cfg(feature = "with-to-string")] | ||
impl std::string::ToString for $type { | ||
fn to_string(&self) -> std::string::String { | ||
let mut res = std::string::String::with_capacity($size * 2); | ||
res.extend(std::iter::repeat('0').take($size * 2)); | ||
let slice = unsafe { &mut res.as_bytes_mut() }; | ||
self.as_ref().iter().rev().enumerate().for_each(|(i, b)| { | ||
hex::encode_to_slice(&[*b], &mut slice[i * 2..i * 2 + 2]).unwrap(); | ||
}); | ||
res | ||
} | ||
} | ||
}; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
EUI64[8]; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
DevNonce[2]; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
AppNonce[3]; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
DevAddr[4]; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
NwkAddr[3]; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
AppKey, 16; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
NewSKey, 16; | ||
} | ||
|
||
fixed_len_struct_impl_to_string_msb! { | ||
AppSKey, 16; | ||
} | ||
|
||
fixed_len_struct_impl_string_lsb! { | ||
DevEui, 8; | ||
} | ||
|
||
fixed_len_struct_impl_string_lsb! { | ||
AppEui, 8; | ||
} | ||
|
||
#[cfg(test)] | ||
mod test { | ||
use super::*; | ||
use crate::extra::std::string::ToString; | ||
use core::str::FromStr; | ||
|
||
#[test] | ||
fn test_appskey_to_string() { | ||
let appskey = AppSKey::from([ | ||
0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef, 0xfd, 0xb9, 0x75, 0x31, 0x24, 0x68, | ||
0xac, 0xed, | ||
]); | ||
assert_eq!(appskey.to_string(), "0123456789abcdeffdb975312468aced"); | ||
} | ||
|
||
#[test] | ||
fn test_appskey_from_str() { | ||
let appskey = AppSKey::from_str("00112233445566778899aabbccddeeff").unwrap(); | ||
assert_eq!( | ||
appskey, | ||
AppSKey::from([ | ||
0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xAA, 0xBB, 0xCC, 0xDD, | ||
0xEE, 0xFF | ||
]) | ||
); | ||
} | ||
|
||
#[test] | ||
fn test_deveui_to_string() { | ||
let deveui = DevEui::from([0xf0, 0xde, 0xbc, 0x9a, 0x78, 0x56, 0x34, 0x12]); | ||
assert_eq!(deveui.to_string(), "123456789abcdef0"); | ||
} | ||
|
||
#[test] | ||
fn test_deveui_from_str() { | ||
let deveui = DevEui::from_str("123456789abcdef0").unwrap(); | ||
assert_eq!(deveui, DevEui::from([0xf0, 0xde, 0xbc, 0x9a, 0x78, 0x56, 0x34, 0x12])); | ||
} | ||
|
||
#[test] | ||
fn test_deveui_from_small_str() { | ||
let result = DevEui::from_str("123456789abcd"); | ||
assert_eq!(result, Err(FromHexError::OddLength)); | ||
} | ||
|
||
#[test] | ||
fn test_deveui_from_large_str() { | ||
let result = DevEui::from_str("123456789abcdef000"); | ||
assert_eq!(result, Err(FromHexError::InvalidStringLength)); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why
-
?Is there a test with under- and oversized hex string?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We never assert size, but the
-
ensure an unwritten char would be obvious.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concerning missized strings, good point! I'll work on that now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The hex library handles them nicely it seems