Struct HexString

pub struct HexString<const C: Case>(/* private fields */);

Provides a structured representation of a hexadecimal string.

It is guaranteed to be a valid hexadecimal string, whether initialized from a string or from bytes. A valid [’HexString`] should contain only alphanumerical characters such as :

• ff04ad992c
• FF04AD99C

And must not mix upper and lower alphabetic characters.

Examples

The idiomatic way to construct a HexString is to call HexString::new method with a string.

use hexstring::{HexString, Case};

let hex = HexString::<{ Case::Upper }>::new("ABCDEF").unwrap();

As the example shown, creating a hexadecimal string is a bit convoluted due to the usage of const generic parameter. Two convenient type aliases must be used instead of the raw HexString type :

use hexstring::{UpperHexString, LowerHexString};

let lowercase_hex = LowerHexString::new("abcdef").unwrap();
let uppercase_hex = UpperHexString::new("ABCDEF").unwrap();

HexString has support for conversion from and into array of bytes.

use hexstring::LowerHexString;

let expected_bytes = [41, 24, 42];
let hex = LowerHexString::from(expected_bytes);
let bytes = Vec::from(hex);

assert_eq!(expected_bytes, &bytes[..]);

Implementations

impl<const C: Case> HexString<C>

pub fn new<S: Into<Cow<'static, str>>>(s: S) -> Result<Self, Error>

Constructs a new HexString from a string.

Errors

This method fails if the given string is not a valid hexadecimal.

pub unsafe fn new_unchecked<S: Into<Cow<'static, str>>>(s: S) -> Self

Creates a new HexString without checking the string.

Safety

The string should be a valid hexadecimal string.

impl HexString<{ Case::Lower }>

pub fn to_uppercase(self) -> UpperHexString

Constructs an UpperHexString from a LowerHexString.

This method performs a copy if the internal string is a string literal.

impl HexString<{ Case::Upper }>

pub fn to_lowercase(self) -> LowerHexString

Constructs a LowerHexString from an UpperHexString.

This method performs a copy if the internal string is a string literal.

Trait Implementations

impl<const C: Case> Clone for HexString<C>

fn clone(&self) -> HexString<C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const C: Case> Debug for HexString<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const C: Case> Default for HexString<C>

fn default() -> HexString<C>

Returns the “default value” for a type.

impl<'de, const C: Case> Deserialize<'de> for HexString<C>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const C: Case> Display for HexString<C>

fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const C: Case> From<&[u8]> for HexString<C>

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.

impl<const C: Case, const N: usize> From<[u8; N]> for HexString<C>

fn from(bytes: [u8; N]) -> Self

Converts to this type from the input type.

impl<const C: Case> From<HexString<C>> for Vec<u8>

fn from(s: HexString<C>) -> Self

Converts to this type from the input type.

impl<const C: Case> From<Vec<u8>> for HexString<C>

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl<const C: Case> FromStr for HexString<C>

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const C: Case> Hash for HexString<C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const C: Case> Ord for HexString<C>

fn cmp(&self, other: &HexString<C>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const C: Case> PartialEq for HexString<C>

fn eq(&self, other: &HexString<C>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const C: Case> PartialOrd for HexString<C>

fn partial_cmp(&self, other: &HexString<C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const C: Case> Serialize for HexString<C>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const C: Case, const N: usize> TryFrom<HexString<C>> for [u8; N]

type Error = FromHexError

The type returned in the event of a conversion error.

fn try_from(s: HexString<C>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const C: Case> Eq for HexString<C>

impl<const C: Case> StructuralPartialEq for HexString<C>