Struct bdk_chain::bitcoin::blockdata::script::Builder

pub struct Builder(/* private fields */);
Expand description

An Object which can be used to construct a script piece by piece.

Implementations§

§

impl Builder

pub const fn new() -> Builder

Creates a new empty script.

pub fn len(&self) -> usize

Returns the length in bytes of the script.

pub fn is_empty(&self) -> bool

Checks whether the script is the empty script.

pub fn push_int(self, data: i64) -> Builder

Adds instructions to push an integer onto the stack.

Integers are encoded as little-endian signed-magnitude numbers, but there are dedicated opcodes to push some small integers.

pub fn push_slice<T>(self, data: T) -> Builder
where T: AsRef<PushBytes>,

Adds instructions to push some arbitrary data onto the stack.

pub fn push_key(self, key: &PublicKey) -> Builder

Adds instructions to push a public key onto the stack.

pub fn push_x_only_key(self, x_only_key: &XOnlyPublicKey) -> Builder

Adds instructions to push an XOnly public key onto the stack.

pub fn push_opcode(self, data: Opcode) -> Builder

Adds a single opcode to the script.

pub fn push_verify(self) -> Builder

Adds an OP_VERIFY to the script or replaces the last opcode with VERIFY form.

Some opcodes such as OP_CHECKSIG have a verify variant that works as if VERIFY was in the script right after. To save space this function appends VERIFY only if the most-recently-added opcode does not have an alternate VERIFY form. If it does the last opcode is replaced. E.g., OP_CHECKSIG will become OP_CHECKSIGVERIFY.

Note that existing OP_*VERIFY opcodes do not lead to the instruction being ignored because OP_VERIFY consumes an item from the stack so ignoring them would change the semantics.

pub fn push_lock_time(self, lock_time: LockTime) -> Builder

Adds instructions to push an absolute lock time onto the stack.

pub fn push_sequence(self, sequence: Sequence) -> Builder

Adds instructions to push a sequence number onto the stack.

pub fn into_script(self) -> ScriptBuf

Converts the Builder into ScriptBuf.

pub fn into_bytes(self) -> Vec<u8>

Converts the Builder into script bytes

pub fn as_script(&self) -> &Script

Returns the internal script

pub fn as_bytes(&self) -> &[u8]

Returns script bytes

Trait Implementations§

§

impl Clone for Builder

§

fn clone(&self) -> Builder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Builder

§

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

Formats the value using the given formatter. Read more
§

impl Default for Builder

§

fn default() -> Builder

Returns the “default value” for a type. Read more
§

impl Display for Builder

§

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

Formats the value using the given formatter. Read more
§

impl From<Vec<u8>> for Builder

Creates a new builder from an existing vector.

§

fn from(v: Vec<u8>) -> Builder

Converts to this type from the input type.
§

impl PartialEq for Builder

§

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

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

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

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

impl Eq for Builder

§

impl StructuralPartialEq for Builder

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V