pub struct ErgoTree { /* private fields */ }Expand description
The root of ErgoScript IR. Serialized instances of this class are self sufficient and can be passed around.
Implementations
impl ErgoTree
impl ErgoTree
Creates a tree using provided header and root expression
pub const MAX_CONSTANTS_COUNT: usize
pub const MAX_CONSTANTS_COUNT: usize
Reasonable limit for the number of constants allowed in the ErgoTree
pub fn proposition(&self) -> Result<Rc<Expr>, ErgoTreeError>
pub fn proposition(&self) -> Result<Rc<Expr>, ErgoTreeError>
get Expr out of ErgoTree
pub fn debug_tree(&self) -> String
pub fn debug_tree(&self) -> String
Prints with newlines
pub fn to_base16_bytes(&self) -> Result<String, SigmaSerializationError>
pub fn to_base16_bytes(&self) -> Result<String, SigmaSerializationError>
Returns Base16-encoded serialized bytes
pub fn constants_len(&self) -> Result<usize, ErgoTreeConstantsParsingError>
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>
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 with_constant(
self,
index: usize,
constant: Constant
) -> Result<ErgoTree, ErgoTreeConstantError>
pub fn with_constant(
self,
index: usize,
constant: Constant
) -> Result<ErgoTree, ErgoTreeConstantError>
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, Global>, ErgoTreeError>
pub fn template_bytes(&self) -> Result<Vec<u8, Global>, ErgoTreeError>
Serialized proposition expression of SigmaProp type with ConstantPlaceholder nodes instead of Constant nodes
Trait Implementations
impl SigmaSerializable for ErgoTree
impl SigmaSerializable for ErgoTree
pub fn sigma_serialize<W>(
&self,
w: &mut W
) -> Result<(), SigmaSerializationError> where
W: SigmaByteWrite,
pub fn sigma_serialize<W>(
&self,
w: &mut W
) -> Result<(), SigmaSerializationError> where
W: SigmaByteWrite,
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 Read more
pub fn sigma_parse<R>(r: &mut R) -> Result<ErgoTree, SigmaParsingError> where
R: SigmaByteRead,
pub fn sigma_parse<R>(r: &mut R) -> Result<ErgoTree, SigmaParsingError> where
R: SigmaByteRead,
Try to read self from the given reader.
sigma- prefix to alert the reader that the serialization in use
is consensus-critical Read more
Parse self from the bytes
fn sigma_serialize_bytes(
&self
) -> Result<Vec<u8, Global>, SigmaSerializationError>
fn sigma_serialize_bytes(
&self
) -> Result<Vec<u8, Global>, SigmaSerializationError>
Serialize any SigmaSerializable value into bytes
impl StructuralEq for ErgoTree
impl StructuralPartialEq for ErgoTree
Auto Trait Implementations
impl RefUnwindSafe for ErgoTree
impl UnwindSafe for ErgoTree
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key and return true if they are equal.
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self to use its Display implementation when
Debug-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted. Read more
Causes self to use its Octal implementation when Debug-formatted.
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.borrow() into the pipe function. Read more
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
Mutably borrows self, then passes self.borrow_mut() into the pipe
function. Read more
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.as_ref() into the pipe function.
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self, then passes self.as_mut() into the pipe
function. Read more
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.deref() into the pipe function.
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B> of a value. Read more
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow() only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut() only in debug builds, and is erased in release
builds. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref() only in debug builds, and is erased in release
builds. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut() only in debug builds, and is erased in release
builds. Read more
impl<T> TryExtractFrom<Expr> for T where
T: TryFrom<Expr>,
impl<T> TryExtractFrom<Expr> for T where
T: TryFrom<Expr>,
pub fn try_extract_from(v: Expr) -> Result<T, TryExtractFromError>
pub fn try_extract_from(v: Expr) -> Result<T, TryExtractFromError>
Extract the value or return an error if type does not match
pub fn try_extract_into<T>(self) -> Result<T, TryExtractFromError> where
T: TryExtractFrom<F>,
pub fn try_extract_into<T>(self) -> Result<T, TryExtractFromError> where
T: TryExtractFrom<F>,
Extract value of the given type from any type (e.g. [‘Constant’], [super::value::Value])
on which [TryExtractFrom] is implemented Read more