Struct bitcoin::blockdata::witness::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() -> Self

Create a new empty Witness

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

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: AsRef<[u8]>>(&mut self, new_element: T)

Push 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

Formats the value using the given formatter.

impl Decodable for Witness

fn consensus_decode<D: Read>(d: D) -> Result<Self, Error>

Decode an object with a well-defined format

impl Default for Witness

fn default() -> Self

Returns the “default value” for a type.

impl Deserialize for Witness

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

Deserialize a value from raw data.

impl<'de> Deserialize<'de> for Witness

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Encodable for Witness

fn consensus_encode<W: Write>(&self, writer: W) -> Result<usize, Error>

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

impl Hash for Witness

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

Feeds this value into the given Hasher.

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Witness> for Witness

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Witness> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Witness

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Serialize for Witness

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

Serialize a value as raw data.

impl Eq for Witness

impl StructuralEq for Witness

impl StructuralPartialEq for Witness