Struct spirq::Manifest

pub struct Manifest { /* fields omitted */ }

A set of information used to describe variable typing and routing.

Methods

impl Manifest

pub fn merge(&mut self, other: &Manifest) -> Result<()>

Merge metadata records in another manifest into the current one IN ORDER. Inputs of the current manifest will kept; outputs will be replaced by the other's; and descriptors will be aggregated to contain both set of metadata.

pub fn get_input<'a>(&'a self, location: InterfaceLocation) -> Option<&'a Type>

Get the input interface variable type.

pub fn get_output<'a>(&'a self, location: InterfaceLocation) -> Option<&'a Type>

Get the output interface variable type.

pub fn get_desc<'a>(
    &'a self,
    desc_bind: DescriptorBinding
) -> Option<&'a DescriptorType>

Get the descriptor type at the given descriptor binding point.

pub fn get_input_name<'a>(
    &'a self,
    location: InterfaceLocation
) -> Option<&'a str>

Get the name that also refers to the input at the given location.

pub fn get_output_name<'a>(
    &'a self,
    location: InterfaceLocation
) -> Option<&'a str>

Get the name that also refers to the output at the given location.

pub fn get_desc_name<'a>(
    &'a self,
    desc_bind: DescriptorBinding
) -> Option<&'a str>

Get the name that also refers to the descriptor at the given descriptor binding.

pub fn get_desc_access(
    &self,
    desc_bind: DescriptorBinding
) -> Option<AccessType>

Get the access pattern of the descriptor at the given descriptor binding.

pub fn resolve_input<S: AsRef<Sym>>(
    &self,
    sym: S
) -> Option<InterfaceVariableResolution>

Get the metadata of a input variable identified by a symbol.

pub fn resolve_output<S: AsRef<Sym>>(
    &self,
    sym: S
) -> Option<InterfaceVariableResolution>

Get the metadata of a output variable identified by a symbol.

pub fn resolve_desc<S: AsRef<Sym>>(
    &self,
    sym: S
) -> Option<DescriptorResolution>

Get the metadata of a descriptor variable identified by a symbol. If the exact variable cannot be resolved, the descriptor part of the resolution will still be returned, if possible.

pub fn inputs<'a>(
    &'a self
) -> impl Iterator<Item = InterfaceVariableResolution<'a>>

List all input locations

pub fn outputs<'a>(
    &'a self
) -> impl Iterator<Item = InterfaceVariableResolution<'a>>

List all output locations in this manifest.

pub fn descs<'a>(&'a self) -> impl Iterator<Item = DescriptorResolution<'a>>

List all descriptors in this manifest. Results will not contain anything about exact variables in buffers.

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Manifest

fn default() -> Manifest

Returns the "default value" for a type.