milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Document `cfg` 

This adds previously-forgotten documentation of items only available on
`alloc` feature.
This commit is contained in:
Martin Habovstiak 2022-09-14 09:06:25 +02:00
parent 6fc4860813
commit 6b96050d1f
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
internals/src/hex/display.rs
View File

@ -45,6 +45,7 @@ pub trait DisplayHex: Copy + sealed::IsRef {
/// ///
/// This may be faster than `.display_hex().to_string()` because it uses `reserve_suggestion`. /// This may be faster than `.display_hex().to_string()` because it uses `reserve_suggestion`.
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
fn to_lower_hex_string(self) -> String { fn to_lower_hex_string(self) -> String {
self.to_hex_string(Case::Lower) self.to_hex_string(Case::Lower)
} }
@ -55,6 +56,7 @@ pub trait DisplayHex: Copy + sealed::IsRef {
/// ///
/// This may be faster than `.display_hex().to_string()` because it uses `reserve_suggestion`. /// This may be faster than `.display_hex().to_string()` because it uses `reserve_suggestion`.
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
fn to_upper_hex_string(self) -> String { fn to_upper_hex_string(self) -> String {
self.to_hex_string(Case::Upper) self.to_hex_string(Case::Upper)
} }
@ -63,6 +65,7 @@ pub trait DisplayHex: Copy + sealed::IsRef {
/// ///
/// This may be faster than `.display_hex().to_string()` because it uses `reserve_suggestion`. /// This may be faster than `.display_hex().to_string()` because it uses `reserve_suggestion`.
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
fn to_hex_string(self, case: Case) -> String { fn to_hex_string(self, case: Case) -> String {
let mut string = String::new(); let mut string = String::new();
self.append_hex_to_string(case, &mut string); self.append_hex_to_string(case, &mut string);
@ -74,6 +77,7 @@ pub trait DisplayHex: Copy + sealed::IsRef {
/// This may be faster than `write!(string, "{}", self.display_hex())` because it uses /// This may be faster than `write!(string, "{}", self.display_hex())` because it uses
/// `reserve_sugggestion`. /// `reserve_sugggestion`.
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
fn append_hex_to_string(self, case: Case, string: &mut String) { fn append_hex_to_string(self, case: Case, string: &mut String) {
use fmt::Write; use fmt::Write;