Struct ProgramCore

pub struct ProgramCore<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> { /* private fields */ }

Implementations

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> ProgramCore<N, Instruction, Command>

pub fn new(id: ProgramID<N>) -> Result<Self>

Initializes an empty program.

pub fn credits() -> Result<Self>

Initializes the credits program.

pub const fn id(&self) -> &ProgramID<N>

Returns the ID of the program.

pub const fn imports(&self) -> &IndexMap<ProgramID<N>, Import<N>>

Returns the imports in the program.

pub const fn mappings(&self) -> &IndexMap<Identifier<N>, Mapping<N>>

Returns the mappings in the program.

pub const fn structs(&self) -> &IndexMap<Identifier<N>, StructType<N>>

Returns the structs in the program.

pub const fn records(&self) -> &IndexMap<Identifier<N>, RecordType<N>>

Returns the records in the program.

pub const fn closures( &self, ) -> &IndexMap<Identifier<N>, ClosureCore<N, Instruction>>

Returns the closures in the program.

pub const fn functions( &self, ) -> &IndexMap<Identifier<N>, FunctionCore<N, Instruction, Command>>

Returns the functions in the program.

pub fn contains_import(&self, id: &ProgramID<N>) -> bool

Returns true if the program contains an import with the given program ID.

pub fn contains_mapping(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a mapping with the given name.

pub fn contains_struct(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a struct with the given name.

pub fn contains_record(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a record with the given name.

pub fn contains_closure(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a closure with the given name.

pub fn contains_function(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a function with the given name.

pub fn get_mapping(&self, name: &Identifier<N>) -> Result<Mapping<N>>

Returns the mapping with the given name.

pub fn get_struct(&self, name: &Identifier<N>) -> Result<&StructType<N>>

Returns the struct with the given name.

pub fn get_record(&self, name: &Identifier<N>) -> Result<&RecordType<N>>

Returns the record with the given name.

pub fn get_closure( &self, name: &Identifier<N>, ) -> Result<ClosureCore<N, Instruction>>

Returns the closure with the given name.

pub fn get_function( &self, name: &Identifier<N>, ) -> Result<FunctionCore<N, Instruction, Command>>

Returns the function with the given name.

pub fn get_function_ref( &self, name: &Identifier<N>, ) -> Result<&FunctionCore<N, Instruction, Command>>

Returns a reference to the function with the given name.

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> ProgramCore<N, Instruction, Command>

pub fn is_reserved_opcode(name: &str) -> bool

Returns true if the given name is a reserved opcode.

pub fn is_reserved_keyword(name: &Identifier<N>) -> bool

Returns true if the given name uses a reserved keyword.

Trait Implementations

impl<N: Clone + Network, Instruction: Clone + InstructionTrait<N>, Command: Clone + CommandTrait<N>> Clone for ProgramCore<N, Instruction, Command>

fn clone(&self) -> ProgramCore<N, Instruction, Command>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> Debug for ProgramCore<N, Instruction, Command>

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

Prints the program as a string.

impl<'de, N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> Deserialize<'de> for ProgramCore<N, Instruction, Command>

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

Deserializes the program from a string or bytes.

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> Display for ProgramCore<N, Instruction, Command>

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

Prints the program as a string.

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> FromBytes for ProgramCore<N, Instruction, Command>

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

Reads Self from reader as little-endian bytes.

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

where Self: Sized,

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

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> FromStr for ProgramCore<N, Instruction, Command>

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

Returns a program from a string literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> Parser for ProgramCore<N, Instruction, Command>

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

Parses a string into a program.

impl<N: PartialEq + Network, Instruction: PartialEq + InstructionTrait<N>, Command: PartialEq + CommandTrait<N>> PartialEq for ProgramCore<N, Instruction, Command>

fn eq(&self, other: &ProgramCore<N, Instruction, Command>) -> 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, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> Serialize for ProgramCore<N, Instruction, Command>

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

Serializes the program into string or bytes.

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> ToBytes for ProgramCore<N, Instruction, Command>

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

Writes self into writer as little-endian bytes.

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, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> TypeName for ProgramCore<N, Instruction, Command>

fn type_name() -> &'static str

Returns the type name as a string.

impl<N: Eq + Network, Instruction: Eq + InstructionTrait<N>, Command: Eq + CommandTrait<N>> Eq for ProgramCore<N, Instruction, Command>

impl<N: Network, Instruction: InstructionTrait<N>, Command: CommandTrait<N>> StructuralPartialEq for ProgramCore<N, Instruction, Command>