Struct quil_rs::program::FrameSet

pub struct FrameSet { /* private fields */ }

A collection of Quil frames (DEFFRAME instructions) with utility methods.

Implementations

impl FrameSet

pub fn new() -> Self

pub fn get(&self, identifier: &FrameIdentifier) -> Option<&FrameAttributes>

Retrieve the attributes of a frame by its identifier.

pub fn get_keys(&self) -> Vec<&FrameIdentifier>

Return a list of all frame IDs described by this FrameSet.

pub fn insert( &mut self, identifier: FrameIdentifier, attributes: FrameAttributes )

Insert a new frame by ID, overwriting any existing one.

pub fn merge(&mut self, other: FrameSet)

Merge another FrameSet with this one, overwriting any existing keys

pub fn intersection(&self, identifiers: &HashSet<&FrameIdentifier>) -> Self

Return a new FrameSet which describes only the given FrameIdentifiers.

pub fn iter(&self) -> Iter<'_, FrameIdentifier, FrameAttributes>

Iterate through the contained frames.

pub fn len(&self) -> usize

Return the number of frames described within.

pub fn is_empty(&self) -> bool

Return true if this describes no frames.

pub fn into_instructions(self) -> Vec<Instruction>

Return the Quil instructions which describe the contained frames, consuming the FrameSet.

pub fn to_instructions(&self) -> Vec<Instruction>

Return the Quil instructions which describe the contained frames.

Trait Implementations

impl Clone for FrameSet

fn clone(&self) -> FrameSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameSet

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

Formats the value using the given formatter.

impl Default for FrameSet

fn default() -> FrameSet

Returns the “default value” for a type.

impl PartialEq<FrameSet> for FrameSet

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

impl StructuralEq for FrameSet

impl StructuralPartialEq for FrameSet