Enum ergotree_ir::ergo_tree::ErgoTree

pub enum ErgoTree {
    Unparsed {
        tree_bytes: Vec<u8>,
        error: ErgoTreeError,
    },
    Parsed(ParsedErgoTree),
}

The root of ErgoScript IR. Serialized instances of this class are self sufficient and can be passed around.

Variants

Unparsed

Fields

tree_bytes: Vec<u8>

Original tree bytes

error: ErgoTreeError

Parsing error

Unparsed tree, with original bytes and error

Parsed(ParsedErgoTree)

Parsed tree

Implementations

impl ErgoTree

pub fn new(header: ErgoTreeHeader, expr: &Expr) -> Result<Self, ErgoTreeError>

Creates a tree using provided header and root expression

pub const MAX_CONSTANTS_COUNT: usize = 4_096usize

Reasonable limit for the number of constants allowed in the ErgoTree

pub fn proposition(&self) -> Result<Expr, ErgoTreeError>

get Expr out of ErgoTree

pub fn debug_tree(&self) -> String

Prints with newlines

pub fn pretty_print(&self) -> Result<(Expr, String), String>

Returns pretty printed tree

pub fn to_base16_bytes(&self) -> Result<String, SigmaSerializationError>

Returns Base16-encoded serialized bytes

pub fn constants_len(&self) -> Result<usize, ErgoTreeError>

Returns constants number as stored in serialized ErgoTree or error if the parsing of constants is failed

pub fn get_constant( &self, index: usize ) -> Result<Option<Constant>, ErgoTreeError>

Returns constant with given index (as stored in serialized ErgoTree) or None if index is out of bounds or error if constants parsing were failed

pub fn get_constants(&self) -> Result<Vec<Constant>, ErgoTreeError>

Returns all constants (as stored in serialized ErgoTree) or error if constants parsing were failed

pub fn with_constant( self, index: usize, constant: Constant ) -> Result<Self, ErgoTreeError>

Returns new ErgoTree with a new constant value for a given index in constants list (as stored in serialized ErgoTree), or an error. Note that the type of the new constant must coincide with that of the constant being replaced, or an error is returned too.

pub fn template_bytes(&self) -> Result<Vec<u8>, ErgoTreeError>

Serialized proposition expression of SigmaProp type with ConstantPlaceholder nodes instead of Constant nodes

Trait Implementations

impl Clone for ErgoTree

fn clone(&self) -> ErgoTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErgoTree

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

Formats the value using the given formatter.

impl From<(Vec<u8>, ErgoTreeError)> for ErgoTree

fn from(original: (Vec<u8>, ErgoTreeError)) -> ErgoTree

Converts to this type from the input type.

impl From<ParsedErgoTree> for ErgoTree

fn from(original: ParsedErgoTree) -> ErgoTree

Converts to this type from the input type.

impl PartialEq for ErgoTree

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

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

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 SigmaSerializable for ErgoTree

fn sigma_serialize<W: SigmaByteWrite>(&self, w: &mut W) -> SigmaSerializeResult

Write self to the given writer. This function has a sigma_ prefix to alert the reader that the serialization in use is consensus-critical serialization

fn sigma_parse<R: SigmaByteRead>(r: &mut R) -> Result<Self, SigmaParsingError>

Try to read self from the given reader. sigma- prefix to alert the reader that the serialization in use is consensus-critical

fn sigma_parse_bytes(bytes: &[u8]) -> Result<Self, SigmaParsingError>

Parse self from the bytes

fn sigma_serialize_bytes(&self) -> Result<Vec<u8>, SigmaSerializationError>

Serialize any SigmaSerializable value into bytes

impl TryFrom<ErgoTree> for ProveDlog

type Error = TryExtractFromError

The type returned in the event of a conversion error.

fn try_from(tree: ErgoTree) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Expr> for ErgoTree

type Error = ErgoTreeError

The type returned in the event of a conversion error.

fn try_from(expr: Expr) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ErgoTree

impl StructuralEq for ErgoTree

impl StructuralPartialEq for ErgoTree