Struct miden_assembly::ast::CodeBody

pub struct CodeBody { /* private fields */ }

A contiguous sequence of Nodes with optional SourceLocation specified for each node.

When present, the number of locations is equal to the number of nodes + 1. This is because the last location tracks the end token of a body which does not have its own node.

Implementations

impl CodeBody

pub fn new<N>(nodes: N) -> Self

where N: IntoIterator<Item = Node>,

Creates a new instance of CodeBody populated with the provided nodes.

Panics

Assumes that the number of nodes is smaller than 2^16 and panics otherwise.

pub fn with_source_locations<L>(self, locations: L) -> Self

where L: IntoIterator<Item = SourceLocation>,

Binds SourceLocations to their respective Node.

It is expected that locations have the length one greater than the length of self.nodes.

pub fn add_final_location(&mut self, location: SourceLocation)

Adds the provided location to the end of location list.

It is expected that prior to calling this method the number of nodes and locations contained in this code body is the same. Thus, after calling this method there will be one more location than node. This is because locations should map 1:1 to their nodes, except for the block termination that is always the last location.

Panics

Panics if the final location has been added previously.

pub fn clear_locations(&mut self)

Removes source location information from this code body.

pub fn load_source_locations<R: ByteReader>( &mut self, source: &mut R ) -> Result<(), DeserializationError>

Loads the SourceLocation from the source.

The source is expected to provide a locations count equal to the block nodes count + 1, having the last element reserved for its end node. This way, the locations count is not expected to be read, as opposed to common vector serialization strategies.

This implementation intentionally diverges from Deserializable so locations can be optionally stored.

pub fn write_source_locations<W: ByteWriter>(&self, target: &mut W)

Writes the SourceLocation into target.

The locations will be written directly, without storing the locations count. This is the counterpart of CodeBody::load_source_locations.

This implementation intentionally diverges from Serializable so locations can be optionally stored.

pub fn nodes(&self) -> &[Node]

Returns the Node sequence.

pub fn source_locations(&self) -> &[SourceLocation]

Returns the [SourceLocations] bound to the nodes of this body structure.

pub fn has_locations(&self) -> bool

Returns true if this code body contain source location information.

pub fn into_parts(self) -> (Vec<Node>, Vec<SourceLocation>)

Returns the internal parts of this code body.

Trait Implementations

impl Clone for CodeBody

fn clone(&self) -> CodeBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeBody

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

Formats the value using the given formatter.

impl Default for CodeBody

fn default() -> CodeBody

Returns the “default value” for a type.

impl FromIterator<(Node, SourceLocation)> for CodeBody

fn from_iter<T: IntoIterator<Item = (Node, SourceLocation)>>(nodes: T) -> Self

Creates a value from an iterator.

impl FromIterator<Node> for CodeBody

fn from_iter<T: IntoIterator<Item = Node>>(nodes: T) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a CodeBody

type Item = (&'a Node, &'a SourceLocation)

The type of the elements being iterated over.

type IntoIter = Zip<Iter<'a, Node>, Iter<'a, SourceLocation>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for CodeBody

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CodeBody