Struct ViewCore 

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

A view function: a top-level, externally-callable, read-only block that returns typed values.

Views share the finalize command set (so they can get, get.or_use, contains against mappings), but cannot mutate state, schedule futures, or call other functions.

Implementations

impl<N: Network> ViewCore<N>

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

Initializes a new view function with the given name.

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

Returns the name of the view function.

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

Returns the view inputs.

pub fn input_types(&self) -> Vec<FinalizeType<N>>

Returns the view input types.

pub fn commands(&self) -> &[Command<N>]

Returns the view commands.

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

Returns the view outputs.

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

Returns the view output types.

pub const fn positions(&self) -> &HashMap<Identifier<N>, usize>

Returns the mapping of Positions to their index in commands.

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

Returns true if the view contains an array type with a size that exceeds the given maximum. Mirrors Finalize::exceeds_max_array_size and additionally walks outputs, since views declare typed outputs.

pub fn contains_external_struct(&self) -> bool

Returns true if the view refers to an external struct in its inputs, body, or outputs.

pub fn contains_string_type(&self) -> bool

Returns true if the view contains a string type. Mirrors Finalize::contains_string_type and additionally walks outputs.

impl<N: Network> ViewCore<N>

pub fn add_command(&mut self, command: Command<N>) -> Result<()>

Adds the given command to the view.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Reads the view function 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 ViewCore<N>

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

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

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

Parses a string into a view function.

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

fn eq(&self, other: &ViewCore<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 ViewCore<N>

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

Writes the view function 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 ViewCore<N>

fn type_name() -> &'static str

Returns the type name of the object as a string. (i.e. “u8”)

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

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