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

units: Don't ignore serde examples 

There is no reason to ignore the rustdoc example in
`units::amount::serde`. The `as_btc` function requires the `alloc`
features so use `as_sat` in the example instead.

While we are at it clean up the whole block of rustdocs.
This commit is contained in:
Tobin C. Harding 2024-12-30 11:25:19 +11:00
parent 33d70529bd
commit 0e5d6db7df
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
units/src/amount/serde.rs
View File

@ -3,19 +3,20 @@
// methods are implementation of a standardized serde-specific signature // methods are implementation of a standardized serde-specific signature
#![allow(missing_docs)] #![allow(missing_docs)]
//! This module adds serde serialization and deserialization support for Amounts. //! This module adds serde serialization and deserialization support for amounts.
//! //!
//! Since there is not a default way to serialize and deserialize Amounts, multiple //! Since there is not a default way to serialize and deserialize amounts, multiple
//! ways are supported and it's up to the user to decide which serialiation to use. //! ways are supported and it's up to the user to decide which serialization to use.
//! The provided modules can be used as follows:
//! //!
//! ```rust,ignore //! # Examples
//!
//! ```
//! use serde::{Serialize, Deserialize}; //! use serde::{Serialize, Deserialize};
//! use bitcoin_units::Amount; //! use bitcoin_units::Amount;
//! //!
//! #[derive(Serialize, Deserialize)] //! #[derive(Serialize, Deserialize)]
//! pub struct HasAmount { //! pub struct HasAmount {
//! #[serde(with = "bitcoin_units::amount::serde::as_btc")] //! #[serde(with = "bitcoin_units::amount::serde::as_sat")]
//! pub amount: Amount, //! pub amount: Amount,
//! } //! }
//! ``` //! ```