Struct bitcoins::types::script::Script

pub struct Script(_);

A Script is marked Vec for use as an opaque Script in SighashArgs structs.

Script::null() and Script::default() return the empty byte vector with a 0 prefix, which represents numerical 0, boolean false, or null bytestring.

Implementations

impl Script

pub fn new(v: Vec<u8>) -> Self

Instantate a new wrapped vector

pub fn null() -> Self

Construct an empty wrapped vector instance.

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

Return a reference to the underlying bytes

pub fn set_items(&mut self, v: Vec<u8>)

Set the underlying items vector.

pub fn push(&mut self, i: u8)

Push an item to the item vector.

pub fn len(&self) -> usize

Return the length of the item vector.

pub fn is_empty(&self) -> bool

Return true if the length of the item vector is 0.

pub fn len_prefix(&self) -> u8

Determine the byte-length of the vector length prefix

pub fn insert(&mut self, index: usize, i: u8)

Insert an item at the specified index.

Trait Implementations

impl AsRef<[u8]> for Script

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl BitcoinScript for Script

impl ByteFormat for Script

type Error = SerError

An associated error type

fn serialized_length(&self) -> usize

Returns the byte-length of the serialized data structure.

fn read_from<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read, 

Deserializes an instance of Self from a std::io::Read. The limit argument is used only when deserializing collections, and specifies a maximum number of instances of the underlying type to read.

fn write_to<W>(&self, writer: &mut W) -> Result<usize, Self::Error> where
    W: Write, 

Serializes self to a std::io::Write. Following Write trait conventions, its Ok type must be a usize denoting the number of bytes written.

pub fn read_seq_from<R>(
    reader: &mut R,
    mode: ReadSeqMode
) -> Result<Vec<Self, Global>, Self::Error> where
    R: Read, 

Read a sequence of exactly limit objects from the reader.

pub fn write_seq_to<'a, W, E, Iter, Item>(
    writer: &mut W,
    iter: Iter
) -> Result<usize, Self::Error> where
    Item: 'a + ByteFormat<Error = E>,
    W: Write,
    Iter: IntoIterator<Item = &'a Item>,
    E: Into<Self::Error> + From<SerError> + From<Error> + Error, 

Write a sequence of ByteFormat objects to a writer. The iter argument may be any object that implements IntoIterator<Item = &Item>. This means we can seamlessly use vectors, slices, etc.

pub fn deserialize_hex(s: &str) -> Result<Self, Self::Error>

Decodes a hex string to a Vec<u8>, deserializes an instance of Self from that vector.

pub fn deserialize_base64(s: &str) -> Result<Self, Self::Error>

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

pub fn serialize_hex(&self) -> String

Serializes self to a vector, returns the hex-encoded vector

pub fn serialize_base64(&self) -> String

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

impl Clone for Script

fn clone(&self) -> Script

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Script

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

Formats the value using the given formatter.

impl Default for Script

fn default() -> Script

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Script

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

Deserialize this value from the given Serde deserializer.

impl Eq for Script

impl Extend<u8> for Script

fn extend<I: IntoIterator<Item = u8>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<&'_ [u8]> for Script

fn from(v: &[u8]) -> Self

Performs the conversion.

impl From<&'_ Script> for ScriptPubkey

fn from(t: &Script) -> ScriptPubkey

Performs the conversion.

impl From<&'_ Script> for ScriptSig

fn from(t: &Script) -> ScriptSig

Performs the conversion.

impl From<&'_ Script> for WitnessStackItem

fn from(t: &Script) -> WitnessStackItem

Performs the conversion.

impl From<&'_ ScriptPubkey> for Script

fn from(t: &ScriptPubkey) -> Script

Performs the conversion.

impl From<&'_ ScriptSig> for Script

fn from(t: &ScriptSig) -> Script

Performs the conversion.

impl From<&'_ WitnessStackItem> for Script

fn from(t: &WitnessStackItem) -> Script

Performs the conversion.

impl From<Vec<u8, Global>> for Script

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

Performs the conversion.

impl Hash for Script

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<Range<usize>> for Script

type Output = [u8]

The returned type after indexing.

fn index(&self, range: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<usize> for Script

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Script

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for Script

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter<u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Script

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Script> for Script

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

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

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

This method tests for !=.

impl PartialOrd<Script> for Script

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Script

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Script

impl StructuralPartialEq for Script