Use W for writer generic type

Generic types can be single letters, and a writer is conventionally, in
this codebase at least, called `W`.

Use `W` instead of `Write` with no loss of clarity.
This commit is contained in:
Tobin C. Harding 2023-12-08 09:38:04 +11:00
parent 8704d9f0ae
commit e2dbcb1d28
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
2 changed files with 9 additions and 9 deletions

View File

@ -673,9 +673,9 @@ impl<R: Borrow<Transaction>> SighashCache<R> {
/// Encodes the BIP341 signing data for any flag type into a given object implementing the /// Encodes the BIP341 signing data for any flag type into a given object implementing the
/// [`io::Write`] trait. /// [`io::Write`] trait.
pub fn taproot_encode_signing_data_to<Write: io::Write + ?Sized, T: Borrow<TxOut>>( pub fn taproot_encode_signing_data_to<W: io::Write + ?Sized, T: Borrow<TxOut>>(
&mut self, &mut self,
writer: &mut Write, writer: &mut W,
input_index: usize, input_index: usize,
prevouts: &Prevouts<T>, prevouts: &Prevouts<T>,
annex: Option<Annex>, annex: Option<Annex>,
@ -860,9 +860,9 @@ impl<R: Borrow<Transaction>> SighashCache<R> {
/// `script_code` is dependent on the type of the spend transaction. For p2wpkh use /// `script_code` is dependent on the type of the spend transaction. For p2wpkh use
/// [`Script::p2wpkh_script_code`], for p2wsh just pass in the witness script. (Also see /// [`Script::p2wpkh_script_code`], for p2wsh just pass in the witness script. (Also see
/// [`Self::p2wpkh_signature_hash`] and [`SighashCache::p2wsh_signature_hash`].) /// [`Self::p2wpkh_signature_hash`] and [`SighashCache::p2wsh_signature_hash`].)
pub fn segwit_v0_encode_signing_data_to<Write: io::Write + ?Sized>( pub fn segwit_v0_encode_signing_data_to<W: io::Write + ?Sized>(
&mut self, &mut self,
writer: &mut Write, writer: &mut W,
input_index: usize, input_index: usize,
script_code: &Script, script_code: &Script,
value: Amount, value: Amount,
@ -984,9 +984,9 @@ impl<R: Borrow<Transaction>> SighashCache<R> {
/// ///
/// This function can't handle the SIGHASH_SINGLE bug internally, so it returns [`EncodeSigningDataResult`] /// This function can't handle the SIGHASH_SINGLE bug internally, so it returns [`EncodeSigningDataResult`]
/// that must be handled by the caller (see [`EncodeSigningDataResult::is_sighash_single_bug`]). /// that must be handled by the caller (see [`EncodeSigningDataResult::is_sighash_single_bug`]).
pub fn legacy_encode_signing_data_to<Write: io::Write + ?Sized, U: Into<u32>>( pub fn legacy_encode_signing_data_to<W: io::Write + ?Sized, U: Into<u32>>(
&self, &self,
writer: &mut Write, writer: &mut W,
input_index: usize, input_index: usize,
script_pubkey: &Script, script_pubkey: &Script,
sighash_type: U, sighash_type: U,
@ -1011,9 +1011,9 @@ impl<R: Borrow<Transaction>> SighashCache<R> {
return EncodeSigningDataResult::SighashSingleBug; return EncodeSigningDataResult::SighashSingleBug;
} }
fn encode_signing_data_to_inner<Write: io::Write + ?Sized>( fn encode_signing_data_to_inner<W: io::Write + ?Sized>(
self_: &Transaction, self_: &Transaction,
writer: &mut Write, writer: &mut W,
input_index: usize, input_index: usize,
script_pubkey: &Script, script_pubkey: &Script,
sighash_type: u32, sighash_type: u32,

View File

@ -1109,7 +1109,7 @@ impl ControlBlock {
/// # Returns /// # Returns
/// ///
/// The number of bytes written to the writer. /// The number of bytes written to the writer.
pub fn encode<Write: io::Write + ?Sized>(&self, writer: &mut Write) -> io::Result<usize> { pub fn encode<W: io::Write + ?Sized>(&self, writer: &mut W) -> io::Result<usize> {
let first_byte: u8 = let first_byte: u8 =
i32::from(self.output_key_parity) as u8 | self.leaf_version.to_consensus(); i32::from(self.output_key_parity) as u8 | self.leaf_version.to_consensus();
writer.write_all(&[first_byte])?; writer.write_all(&[first_byte])?;