Enum GenericArrayOpDef

#[non_exhaustive]
pub enum GenericArrayOpDef<AK: ArrayKind> {
    new_array,
    get,
    set,
    swap,
    pop_left,
    pop_right,
    discard_empty,
    _phantom(PhantomData<AK>, Never),
    unpack,
}

Array operation definitions. Generic over the concrete array implementation.

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>, array

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)

_phantom(PhantomData<AK>, Never)

Not an actual operation definition, but an unhabitable variant that references AK to ensure that the type parameter is used.

unpack

Unpacks an array into its individual elements: unpack<SIZE><elemty>: array<SIZE, elemty> -> (elemty)^SIZE where SIZE must be statically known (not a variable)

Implementations

impl<AK: ArrayKind> GenericArrayOpDef<AK>

pub fn to_concrete(self, elem_ty: Type, size: u64) -> GenericArrayOp<AK>

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

Trait Implementations

impl<AK: Clone + ArrayKind> Clone for GenericArrayOpDef<AK>

fn clone(&self) -> GenericArrayOpDef<AK>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<AK: Debug + ArrayKind> Debug for GenericArrayOpDef<AK>

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

Formats the value using the given formatter.

impl<'_derivative_strum, AK: ArrayKind> From<&'_derivative_strum GenericArrayOpDef<AK>> for &'static str

fn from(x: &'_derivative_strum GenericArrayOpDef<AK>) -> &'static str

Converts to this type from the input type.

impl<AK: ArrayKind> From<GenericArrayOpDef<AK>> for &'static str

fn from(x: GenericArrayOpDef<AK>) -> &'static str

Converts to this type from the input type.

impl<AK: ArrayKind> FromStr for GenericArrayOpDef<AK>

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl<AK: ArrayKind> HasConcrete for GenericArrayOpDef<AK>

type Concrete = GenericArrayOp<AK>

Associated concrete type.

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

Instantiate the operation with type arguments.

impl<AK: Hash + ArrayKind> Hash for GenericArrayOpDef<AK>

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<AK: ArrayKind> IntoEnumIterator for GenericArrayOpDef<AK>

type Iterator = GenericArrayOpDefIter<AK>

fn iter() -> GenericArrayOpDefIter<AK>

impl<AK: ArrayKind> MakeOpDef for GenericArrayOpDef<AK>

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 opdef_id(&self) -> OpName

The OpDef::name which will be used when Self is added to an Extension or when Self is loaded from an OpDef.

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.opdef_id().

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<AK: PartialEq + ArrayKind> PartialEq for GenericArrayOpDef<AK>

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

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<AK: ArrayKind> TryFrom<&str> for GenericArrayOpDef<AK>

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<AK: Copy + ArrayKind> Copy for GenericArrayOpDef<AK>

impl<AK: Eq + ArrayKind> Eq for GenericArrayOpDef<AK>

impl<AK: ArrayKind> StructuralPartialEq for GenericArrayOpDef<AK>