Struct ClosureCore 

pub struct ClosureCore<N: Network> { /* private fields */ }

Implementations

impl<N: Network> ClosureCore<N>

pub fn new(name: Identifier<N>) -> Self

Initializes a new closure with the given name.

pub const fn name(&self) -> &Identifier<N>

Returns the name of the closure.

pub const fn inputs(&self) -> &IndexSet<Input<N>>

Returns the closure inputs.

pub fn instructions(&self) -> &[Instruction<N>]

Returns the closure instructions.

pub const fn outputs(&self) -> &IndexSet<Output<N>>

Returns the closure outputs.

pub fn output_types(&self) -> Vec<RegisterType<N>>

Returns the closure output types.

pub fn contains_external_struct(&self) -> bool

Returns whether the closure refers to an external struct.

pub fn contains_string_type(&self) -> bool

Returns true if the closure instructions contain a string type. Note that input and output types don’t have to be checked if we are sure the broader function doesn’t contain a string type.

pub fn contains_identifier_type(&self) -> Result<bool>

Returns true if the closure contains an identifier type in its inputs, outputs, or instructions.

pub fn exceeds_max_array_size(&self, max_array_size: u32) -> bool

Returns true if the closure contains an array type with a size that exceeds the given maximum.

impl<N: Network> ClosureCore<N>

pub fn add_instruction(&mut self, instruction: Instruction<N>) -> Result<()>

Adds the given instruction to the closure.

Errors

This method will halt if there are output statements already. This method will halt if the maximum number of instructions has been reached.

Trait Implementations

impl<N: Clone + Network> Clone for ClosureCore<N>

fn clone(&self) -> ClosureCore<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for ClosureCore<N>

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

Prints the closure as a string.

impl<N: Network> Display for ClosureCore<N>

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

Prints the closure as a string.

impl<N: Network> FromBytes for ClosureCore<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the closure from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N: Network> FromStr for ClosureCore<N>

fn from_str(string: &str) -> Result<Self>

Returns a closure from a string literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Network> Parser for ClosureCore<N>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a closure.

impl<N: PartialEq + Network> PartialEq for ClosureCore<N>

fn eq(&self, other: &ClosureCore<N>) -> 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<N: Network> ToBytes for ClosureCore<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the closure to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Network> TypeName for ClosureCore<N>

fn type_name() -> &'static str

Returns the type name as a string.

impl<N: Eq + Network> Eq for ClosureCore<N>

impl<N: Network> StructuralPartialEq for ClosureCore<N>