Struct Builder

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

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

Implementations

impl Builder

pub 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_scriptint(self, data: i64) -> Builder

Adds instructions to push an integer onto the stack, using the explicit encoding regardless of the availability of dedicated opcodes.

pub fn push_slice(self, data: &[u8]) -> Builder

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: All) -> Builder

Adds a single opcode to the script.

pub fn push_verify(self) -> Builder

Adds an OP_VERIFY to the script, unless the most-recently-added opcode has an alternate VERIFY form, in which case that opcode is replaced e.g., OP_CHECKSIG will become OP_CHECKSIGVERIFY.

pub fn into_script(self) -> Script

Converts the Builder into an unmodifiable Script.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl Display for Builder

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

Formats the value using the given formatter.

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<I> Index<I> for Builder

where Vec<u8>: Index<I>,

type Output = <Vec<u8> as Index<I>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<Builder as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl PartialEq for Builder

fn eq(&self, other: &Builder) -> 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 Eq for Builder

impl StructuralPartialEq for Builder