Struct ergotree_ir::ergo_tree::ErgoTree

pub struct ErgoTree { /* fields omitted */ }

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

Implementations

impl ErgoTree

pub const MAX_CONSTANTS_COUNT: usize

Reasonable limit for the number of constants allowed in the ErgoTree

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

get Expr out of ErgoTree

pub fn without_segregation(expr: Expr) -> ErgoTree

Build ErgoTree using expr as is, without constants segregated

pub fn with_segregation(expr: &Expr) -> ErgoTree

Build ErgoTree with constants segregated from expr

pub fn debug_tree(&self) -> String

Prints with newlines

pub fn to_base16_bytes(&self) -> String

Returns Base16-encoded serialized bytes

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

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>, ErgoTreeConstantsParsingError>

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 set_constant(
    &mut self,
    index: usize,
    constant: Constant
) -> Result<Option<Constant>, ErgoTreeConstantsParsingError>

Sets new constant value for a given index in constants list (as stored in serialized ErgoTree), and returns previous constant or None if index is out of bounds or error if constants parsing were failed

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

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

fn from(expr: Expr) -> Self

Performs the conversion.

impl PartialEq<ErgoTree> 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: &ErgoTree) -> bool

This method tests for !=.

impl SigmaSerializable for ErgoTree

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

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
Notice that the error type is std::io::Error; this indicates that serialization MUST be infallible up to errors in the underlying writer. In other words, any type implementing SigmaSerializable must make illegal states unrepresentable.

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

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, SerializationError>

Parse self from the bytes

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

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

impl StructuralEq for ErgoTree

impl StructuralPartialEq for ErgoTree