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

Improve docs on parse::int_from_string 

I only just worked on this function a week ago and already I couldn't
see from reading the code why it exists. Add a paragraph to the rustdocs
to save the next guy the trouble of working it out.
This commit is contained in:
Tobin C. Harding 2025-01-20 13:34:09 +11:00
parent d97cbc6d27
commit f1e2564821
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
units/src/parse.rs
View File

@ -76,6 +76,11 @@ mod sealed {
/// Parses the input string as an integer returning an error carrying rich context. /// Parses the input string as an integer returning an error carrying rich context.
/// ///
/// Apart from the rich error context this function exists so that we can handle builds with and
/// without an allocator. If an allocator is available (`alloc` feature enabled) then this function
/// allocates to copy the input string into the error return. If `alloc` is not enabled the input
/// string is lost.
///
/// If the caller has a `String` or `Box<str>` which is not used later it's better to call /// If the caller has a `String` or `Box<str>` which is not used later it's better to call
/// [`parse::int_from_string`] or [`parse::int_from_box`] respectively. /// [`parse::int_from_string`] or [`parse::int_from_box`] respectively.
/// ///