Enum ArrayOpDef

#[non_exhaustive]
pub enum ArrayOpDef {
    new_array,
    get,
    set,
    swap,
    pop_left,
    pop_right,
    discard_empty,
}

Array operation definitions.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

new_array

Makes a new array, given distinct inputs equal to its length: new_array<SIZE><elemty>: (elemty)^SIZE -> array<SIZE, elemty> where SIZE must be statically known (not a variable)

get

Copies an element out of the array (TypeBound::Copyable elements only): get<size,elemty>: array<size, elemty>, index -> option<elemty>

set

Exchanges an element of the array with an external value: set<size, elemty>: array<size, elemty>, index, elemty -> either(elemty, array | elemty, array) tagged for failure/success respectively

swap

Exchanges the elements at two indices within the array: swap<size, elemty>: array<size, elemty>, index, index -> either(array, array) tagged for failure/success respectively

pop_left

Separates the leftmost element from the rest of the array: pop_left<SIZE><elemty>: array<SIZE, elemty> -> Option<elemty, array<SIZE-1, elemty>> where SIZE must be known statically (not a variable). None is returned if the input array was size 0.

pop_right

Separates the rightmost element from the rest of the array. pop_right<SIZE><elemty>: array<SIZE, elemty> -> Option<elemty, array<SIZE-1, elemty>> where SIZE must be known statically (not a variable). None is returned if the input array was size 0.

discard_empty

Allows discarding a 0-element array of linear type. discard_empty<elemty>: array<0, elemty> -> (no outputs)

Implementations

impl ArrayOpDef

pub fn to_concrete(self, elem_ty: Type, size: u64) -> ArrayOp

Instantiate a new array operation with the given element type and array size.

Trait Implementations

impl Clone for ArrayOpDef

fn clone(&self) -> ArrayOpDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayOpDef

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

Formats the value using the given formatter.

impl<'_derivative_strum> From<&'_derivative_strum ArrayOpDef> for &'static str

fn from(x: &'_derivative_strum ArrayOpDef) -> &'static str

Converts to this type from the input type.

impl From<ArrayOpDef> for &'static str

fn from(x: ArrayOpDef) -> &'static str

Converts to this type from the input type.

impl FromStr for ArrayOpDef

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ArrayOpDef, <Self as FromStr>::Err>

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

impl HasConcrete for ArrayOpDef

type Concrete = ArrayOp

Associated concrete type.

fn instantiate( &self, type_args: &[TypeArg], ) -> Result<Self::Concrete, OpLoadError>

Instantiate the operation with type arguments.

impl Hash for ArrayOpDef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for ArrayOpDef

type Iterator = ArrayOpDefIter

fn iter() -> ArrayOpDefIter

impl MakeOpDef for ArrayOpDef

fn add_to_extension( &self, extension: &mut Extension, extension_ref: &Weak<Extension>, ) -> Result<(), ExtensionBuildError>

Add an operation implemented as an MakeOpDef, which can provide the data required to define an OpDef, to an extension.

fn from_def(op_def: &OpDef) -> Result<Self, OpLoadError>

where Self: Sized,

Try to load one of the operations of this set from an OpDef.

fn init_signature(&self, extension_ref: &Weak<Extension>) -> SignatureFunc

Compute the signature of the operation while the extension definition is being built.

fn extension_ref(&self) -> Weak<Extension>

Returns a weak reference to the extension this operation is defined in.

fn extension(&self) -> ExtensionId

The ID of the extension this operation is defined in.

fn description(&self) -> String

Description of the operation. By default, the same as self.name().

fn signature(&self) -> SignatureFunc

Return the signature (polymorphic function type) of the operation.

fn post_opdef(&self, _def: &mut OpDef)

Edit the opdef before finalising. By default does nothing.

fn load_all_ops( extension: &mut Extension, extension_ref: &Weak<Extension>, ) -> Result<(), ExtensionBuildError>

where Self: IntoEnumIterator,

Load all variants of an enum of op definitions in to an extension as op defs. See strum::IntoEnumIterator.

fn from_op(ext_op: &ExtensionOp) -> Result<Self, OpLoadError>

where Self: Sized + FromStr,

If the definition can be loaded from a string, load from an ExtensionOp.

impl PartialEq for ArrayOpDef

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

fn compute_signature( &self, arg_values: &[TypeArg], ) -> Result<PolyFuncTypeRV, SignatureError>

Compute signature of node given values for the type parameters.

fn static_params(&self) -> &[TypeParam]

The declared type parameters which require values in order for signature to be computed.

impl TryFrom<&str> for ArrayOpDef

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<ArrayOpDef, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for ArrayOpDef

impl Eq for ArrayOpDef

impl StructuralPartialEq for ArrayOpDef