Trait bdk_chain::bitcoin::hashes::hex::DisplayHex
pub trait DisplayHex: Copy + IsRef {
type Display: Display + Debug + LowerHex + UpperHex;
// Required method
fn as_hex(self) -> Self::Display;
// Provided methods
fn to_lower_hex_string(self) -> String { ... }
fn to_upper_hex_string(self) -> String { ... }
fn to_hex_string(self, case: Case) -> String { ... }
fn append_hex_to_string(self, case: Case, string: &mut String) { ... }
fn hex_reserve_suggestion(self) -> usize { ... }
}
Expand description
Extension trait for types that can be displayed as hex.
Types that have a single, obvious text representation being hex should not implement this
trait and simply implement Display
instead.
This trait should be generally implemented for references only. We would prefer to use GAT but
that is beyond our MSRV. As a lint we require the IsRef
trait which is implemented for all
references.
Required Associated Types§
Required Methods§
Provided Methods§
fn to_lower_hex_string(self) -> String
fn to_lower_hex_string(self) -> String
Create a lower-hex-encoded string.
A shorthand for to_hex_string(Case::Lower)
, so that Case
doesn’t need to be imported.
This may be faster than .display_hex().to_string()
because it uses reserve_suggestion
.
fn to_upper_hex_string(self) -> String
fn to_upper_hex_string(self) -> String
Create an upper-hex-encoded string.
A shorthand for to_hex_string(Case::Upper)
, so that Case
doesn’t need to be imported.
This may be faster than .display_hex().to_string()
because it uses reserve_suggestion
.
fn to_hex_string(self, case: Case) -> String
fn to_hex_string(self, case: Case) -> String
Create a hex-encoded string.
This may be faster than .display_hex().to_string()
because it uses reserve_suggestion
.
fn append_hex_to_string(self, case: Case, string: &mut String)
fn append_hex_to_string(self, case: Case, string: &mut String)
Appends hex-encoded content to an existing String
.
This may be faster than write!(string, "{:x}", self.as_hex())
because it uses
hex_reserve_sugggestion
.
fn hex_reserve_suggestion(self) -> usize
fn hex_reserve_suggestion(self) -> usize
Hints how much bytes to reserve when creating a String
.
Implementors that know the number of produced bytes upfront should override this. Defaults to 0.