Struct Witness

pub struct Witness { /* private fields */ }

The Witness is the data used to unlock bitcoins since the segwit upgrade

Can be logically seen as an array of byte-arrays Vec<Vec<u8>> and indeed you can convert from it Witness::from_vec and convert into it Witness::to_vec.

For serialization and deserialization performance it is stored internally as a single Vec, saving some allocations.

Implementations

impl Witness

pub fn new() -> Witness

Create a new empty Witness

pub fn from_vec(vec: Vec<Vec<u8>>) -> Witness

Creates Witness object from an array of byte-arrays

pub fn to_vec(&self) -> Vec<Vec<u8>>

Convenience method to create an array of byte-arrays from this witness

pub fn is_empty(&self) -> bool

Returns true if the witness contains no element

pub fn iter(&self) -> Iter<'_>

Returns a struct implementing Iterator

pub fn len(&self) -> usize

Returns the number of elements this witness holds

pub fn serialized_len(&self) -> usize

Returns the bytes required when this Witness is consensus encoded

pub fn clear(&mut self)

Clear the witness

pub fn push<T>(&mut self, new_element: T)

where T: AsRef<[u8]>,

Push a new element on the witness, requires an allocation

pub fn push_bitcoin_signature( &mut self, signature: &SerializedSignature, hash_type: EcdsaSighashType, )

Pushes a DER-encoded ECDSA signature with a signature hash type as a new element on the witness, requires an allocation.

pub fn last(&self) -> Option<&[u8]>

Return the last element in the witness, if any

pub fn second_to_last(&self) -> Option<&[u8]>

Return the second-to-last element in the witness, if any

Trait Implementations

impl Clone for Witness

fn clone(&self) -> Witness

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Witness

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Decodable for Witness

fn consensus_decode<R>(r: &mut R) -> Result<Witness, Error>

where R: Read + ?Sized,

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

impl Default for Witness

fn default() -> Witness

Returns the “default value” for a type.

impl Deserialize for Witness

fn deserialize(bytes: &[u8]) -> Result<Witness, Error>

Deserialize a value from raw data.

impl Encodable for Witness

fn consensus_encode<W>(&self, w: &mut W) -> Result<usize, Error>

where W: Write + ?Sized,

Encode an object with a well-defined format. Returns the number of bytes written on success.

impl Hash for Witness

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Witness

fn cmp(&self, other: &Witness) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Witness

fn eq(&self, other: &Witness) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Witness

fn partial_cmp(&self, other: &Witness) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Readable for Witness

fn read<R>(r: &mut R) -> Result<Witness, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Serialize for Witness

fn serialize(&self) -> Vec<u8>

Serialize a value as raw data.

impl Writeable for Witness

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for Witness

impl StructuralPartialEq for Witness