Standardize function doc Errors
Changed the function docs to have the same format of /// /// # Errors /// /// description
This commit is contained in:
parent
d219ceb68e
commit
df83016c98
|
@ -207,7 +207,7 @@ mod primitive {
|
||||||
|
|
||||||
/// Try pushing a single byte.
|
/// Try pushing a single byte.
|
||||||
///
|
///
|
||||||
/// ## Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// This method fails if `self` would exceed the limit.
|
/// This method fails if `self` would exceed the limit.
|
||||||
#[allow(deprecated)]
|
#[allow(deprecated)]
|
||||||
|
@ -220,7 +220,7 @@ mod primitive {
|
||||||
|
|
||||||
/// Try appending a slice to `PushBytesBuf`
|
/// Try appending a slice to `PushBytesBuf`
|
||||||
///
|
///
|
||||||
/// ## Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// This method fails if `self` would exceed the limit.
|
/// This method fails if `self` would exceed the limit.
|
||||||
pub fn extend_from_slice(&mut self, bytes: &[u8]) -> Result<(), PushBytesError> {
|
pub fn extend_from_slice(&mut self, bytes: &[u8]) -> Result<(), PushBytesError> {
|
||||||
|
|
|
@ -67,7 +67,7 @@ impl Psbt {
|
||||||
/// For each PSBT input that contains UTXO information `Ok` is returned containing that information.
|
/// For each PSBT input that contains UTXO information `Ok` is returned containing that information.
|
||||||
/// The order of returned items is same as the order of inputs.
|
/// The order of returned items is same as the order of inputs.
|
||||||
///
|
///
|
||||||
/// ## Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// The function returns error when UTXO information is not present or is invalid.
|
/// The function returns error when UTXO information is not present or is invalid.
|
||||||
///
|
///
|
||||||
|
@ -140,7 +140,7 @@ impl Psbt {
|
||||||
|
|
||||||
/// Extracts the [`Transaction`] from a [`Psbt`] by filling in the available signature information.
|
/// Extracts the [`Transaction`] from a [`Psbt`] by filling in the available signature information.
|
||||||
///
|
///
|
||||||
/// ## Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// [`ExtractTxError`] variants will contain either the [`Psbt`] itself or the [`Transaction`]
|
/// [`ExtractTxError`] variants will contain either the [`Psbt`] itself or the [`Transaction`]
|
||||||
/// that was extracted. These can be extracted from the Errors in order to recover.
|
/// that was extracted. These can be extracted from the Errors in order to recover.
|
||||||
|
@ -151,7 +151,7 @@ impl Psbt {
|
||||||
|
|
||||||
/// Extracts the [`Transaction`] from a [`Psbt`] by filling in the available signature information.
|
/// Extracts the [`Transaction`] from a [`Psbt`] by filling in the available signature information.
|
||||||
///
|
///
|
||||||
/// ## Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// See [`extract_tx`].
|
/// See [`extract_tx`].
|
||||||
///
|
///
|
||||||
|
@ -703,7 +703,7 @@ impl Psbt {
|
||||||
/// 'Fee' being the amount that will be paid for mining a transaction with the current inputs
|
/// 'Fee' being the amount that will be paid for mining a transaction with the current inputs
|
||||||
/// and outputs i.e., the difference in value of the total inputs and the total outputs.
|
/// and outputs i.e., the difference in value of the total inputs and the total outputs.
|
||||||
///
|
///
|
||||||
/// ## Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// - [`Error::MissingUtxo`] when UTXO information for any input is not present or is invalid.
|
/// - [`Error::MissingUtxo`] when UTXO information for any input is not present or is invalid.
|
||||||
/// - [`Error::NegativeFee`] if calculated value is negative.
|
/// - [`Error::NegativeFee`] if calculated value is negative.
|
||||||
|
|
|
@ -188,6 +188,7 @@ where
|
||||||
/// Constructs a [`ProprietaryKey`] from a [`Key`].
|
/// Constructs a [`ProprietaryKey`] from a [`Key`].
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
|
///
|
||||||
/// Returns [`Error::InvalidProprietaryKey`] if `key` does not start with `0xFC` byte.
|
/// Returns [`Error::InvalidProprietaryKey`] if `key` does not start with `0xFC` byte.
|
||||||
fn try_from(key: Key) -> Result<Self, Self::Error> {
|
fn try_from(key: Key) -> Result<Self, Self::Error> {
|
||||||
if key.type_value != 0xFC {
|
if key.type_value != 0xFC {
|
||||||
|
|
|
@ -66,6 +66,7 @@ impl TaprootMerkleBranch {
|
||||||
/// Creates a merkle proof from list of hashes.
|
/// Creates a merkle proof from list of hashes.
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
|
///
|
||||||
/// If inner proof length is more than [`TAPROOT_CONTROL_MAX_NODE_COUNT`] (128).
|
/// If inner proof length is more than [`TAPROOT_CONTROL_MAX_NODE_COUNT`] (128).
|
||||||
#[inline]
|
#[inline]
|
||||||
fn from_collection<T: AsRef<[TapNodeHash]> + Into<Vec<TapNodeHash>>>(
|
fn from_collection<T: AsRef<[TapNodeHash]> + Into<Vec<TapNodeHash>>>(
|
||||||
|
@ -123,6 +124,7 @@ macro_rules! impl_try_from {
|
||||||
/// Creates a merkle proof from list of hashes.
|
/// Creates a merkle proof from list of hashes.
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
|
///
|
||||||
/// If inner proof length is more than [`TAPROOT_CONTROL_MAX_NODE_COUNT`] (128).
|
/// If inner proof length is more than [`TAPROOT_CONTROL_MAX_NODE_COUNT`] (128).
|
||||||
#[inline]
|
#[inline]
|
||||||
fn try_from(v: $from) -> Result<Self, Self::Error> {
|
fn try_from(v: $from) -> Result<Self, Self::Error> {
|
||||||
|
|
|
@ -429,8 +429,13 @@ impl TaprootBuilder {
|
||||||
Ok(TaprootBuilder { branch: vec![Some(node)] })
|
Ok(TaprootBuilder { branch: vec![Some(node)] })
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Adds a leaf script at `depth` to the builder with script version `ver`. Errors if the leaves
|
/// Adds a leaf script at `depth` to the builder with script version `ver`.
|
||||||
/// are not provided in DFS walk order. The depth of the root node is 0.
|
///
|
||||||
|
/// The depth of the root node is 0.
|
||||||
|
///
|
||||||
|
/// # Errors
|
||||||
|
///
|
||||||
|
/// Errors if the leaves are not provided in DFS walk order.
|
||||||
pub fn add_leaf_with_ver(
|
pub fn add_leaf_with_ver(
|
||||||
self,
|
self,
|
||||||
depth: u8,
|
depth: u8,
|
||||||
|
@ -441,16 +446,26 @@ impl TaprootBuilder {
|
||||||
self.insert(leaf, depth)
|
self.insert(leaf, depth)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Adds a leaf script at `depth` to the builder with default script version. Errors if the
|
/// Adds a leaf script at `depth` to the builder with default script version.
|
||||||
/// leaves are not provided in DFS walk order. The depth of the root node is 0.
|
///
|
||||||
|
/// The depth of the root node is 0.
|
||||||
///
|
///
|
||||||
/// See [`TaprootBuilder::add_leaf_with_ver`] for adding a leaf with specific version.
|
/// See [`TaprootBuilder::add_leaf_with_ver`] for adding a leaf with specific version.
|
||||||
|
///
|
||||||
|
/// # Errors
|
||||||
|
///
|
||||||
|
/// Errors if the leaves are not provided in DFS walk order.
|
||||||
pub fn add_leaf(self, depth: u8, script: ScriptBuf) -> Result<Self, TaprootBuilderError> {
|
pub fn add_leaf(self, depth: u8, script: ScriptBuf) -> Result<Self, TaprootBuilderError> {
|
||||||
self.add_leaf_with_ver(depth, script, LeafVersion::TapScript)
|
self.add_leaf_with_ver(depth, script, LeafVersion::TapScript)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Adds a hidden/omitted node at `depth` to the builder. Errors if the leaves are not provided
|
/// Adds a hidden/omitted node at `depth` to the builder.
|
||||||
/// in DFS walk order. The depth of the root node is 0.
|
///
|
||||||
|
/// The depth of the root node is 0.
|
||||||
|
///
|
||||||
|
/// # Errors
|
||||||
|
///
|
||||||
|
/// Errors if the leaves are not provided in DFS walk order.
|
||||||
pub fn add_hidden_node(
|
pub fn add_hidden_node(
|
||||||
self,
|
self,
|
||||||
depth: u8,
|
depth: u8,
|
||||||
|
|
Loading…
Reference in New Issue