Struct DynamicFuture 

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

A dynamic future is a fixed-size representation of a future. Like static Futures, a dynamic future contains a program name, program network, and function name. These are however represented as Field elements as opposed to Identifiers to ensure a fixed size. Dynamic futures also store a checksum of the arguments to the future instead of the arguments themselves. This ensures that all dynamic futures have a constant size, regardless of the amount of data they contain.

The checksum is computed as truncate_252(Sha3_256(bits)), where bits is constructed by:

1. Prefixing with the number of arguments as a u8 in little-endian bits.
2. Appending the type-prefixed to_bits_le() of each argument.
3. Padding the result to the next multiple of 8 bits.

The 256-bit SHA-3 output is truncated to the field’s data capacity (252 bits) and packed into a field element.

Implementations

impl<N: Network> DynamicFuture<N>

pub fn size_in_bits() -> Result<usize>

Returns the number of bits in a dynamic future.

pub fn size_in_bits_raw() -> Result<usize>

Returns the number of raw bits in a dynamic future.

impl<N: Network> DynamicFuture<N>

pub fn new_unchecked( program_name: Field<N>, program_network: Field<N>, function_name: Field<N>, checksum: Field<N>, arguments: Option<Vec<Argument<N>>>, ) -> Self

Initializes a dynamic future without checking that the checksum and arguments are consistent.

impl<N: Network> DynamicFuture<N>

pub const fn program_name(&self) -> &Field<N>

Returns the program name.

pub const fn program_network(&self) -> &Field<N>

Returns the program network.

pub const fn function_name(&self) -> &Field<N>

Returns the function name.

pub const fn checksum(&self) -> &Field<N>

Returns the checksum of the arguments.

pub const fn arguments(&self) -> &Option<Vec<Argument<N>>>

Returns the optional arguments.

impl<N: Network> DynamicFuture<N>

pub fn from_future(future: &Future<N>) -> Result<Self>

Creates a dynamic future from a static future.

pub fn to_future(&self) -> Result<Future<N>>

Creates a static future from a dynamic future.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Prints the future as a string.

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

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

Prints the future as a string.

Attempts to display in human-readable format if the fields can be converted to identifiers. Falls back to raw field format if conversion fails.

impl<N: Network> Equal for DynamicFuture<N>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

impl<N: Network> From<&DynamicFuture<N>> for Value<N>

fn from(dynamic_future: &DynamicFuture<N>) -> Self

Initializes the value from a dynamic future.

impl<N: Network> From<DynamicFuture<N>> for Value<N>

fn from(dynamic_future: DynamicFuture<N>) -> Self

Initializes the value from a dynamic future.

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

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

Reads in a dynamic future 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 DynamicFuture<N>

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

Returns a future from a string literal.

type Err = Error

The associated error which can be returned from parsing.

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

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

Parses a string into a dynamic future.

Supports two formats:

• Human-readable: { _program_id: foo.aleo, _function_name: bar, _checksum: 0field }
• Raw field: { _program_name: 0field, _program_network: 0field, _function_name: 0field, _checksum: 0field }

impl<N: Network> PartialEq for DynamicFuture<N>

fn eq(&self, other: &Self) -> bool

Returns true if self and other are equal.

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> ToBits for DynamicFuture<N>

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the dynamic future as a list of little-endian bits.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the dynamic future as a list of big-endian bits.

fn to_bits_le(&self) -> Vec<bool>

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

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N: Network> ToBytes for DynamicFuture<N>

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

Writes a dynamic future 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> ToFields for DynamicFuture<N>

fn to_fields(&self) -> Result<Vec<Self::Field>>

Returns the dynamic future as a list of fields.

type Field = Field<N>

impl<N: Network> Eq for DynamicFuture<N>