Struct Const 

#[non_exhaustive]
pub struct Const {
    pub value: Value,
}

An operation returning a constant value.

Represents core types and extension types.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: Value

The Value of the constant.

Implementations

impl Const

pub fn new(value: Value) -> Const

Create a new Const operation.

pub fn value(&self) -> &Value

The inner value of the Const

pub fn get_type(&self) -> TypeBase<NoRV>

Returns the type of this constant.

pub fn get_custom_value<T>(&self) -> Option<&T>

where T: CustomConst,

For a Const holding a CustomConst, extract the CustomConst by downcasting.

pub fn validate(&self) -> Result<(), ConstTypeError>

Check the value.

Trait Implementations

impl AsRef<Value> for Const

fn as_ref(&self) -> &Value

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Const

fn clone(&self) -> Const

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Const

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Const

fn deserialize<__D>( __deserializer: __D, ) -> Result<Const, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Const> for OpType

fn from(v: Const) -> OpType

Converts to this type from the input type.

impl From<Const> for Value

fn from(konst: Const) -> Value

Converts to this type from the input type.

impl From<Value> for Const

fn from(value: Value) -> Const

Converts to this type from the input type.

impl OpParent for Const

fn inner_function_type(&self) -> Option<Cow<'_, FuncTypeBase<NoRV>>>

The inner function type of the operation, if it has a child dataflow sibling graph.

impl OpTrait for Const

fn description(&self) -> &'static str

A human-readable description of the operation.

fn tag(&self) -> OpTag

Tag identifying the operation.

fn static_output(&self) -> Option<EdgeKind>

The edge kind for a single constant output of the operation, not described by the dataflow signature.

fn try_node_handle<N, H>(&self, node: N) -> Option<H>

where N: HugrNode, H: NodeHandle<N> + From<N>,

Tries to create a specific NodeHandle for a node with this operation type.

fn dataflow_signature(&self) -> Option<Cow<'_, FuncTypeBase<NoRV>>>

The signature of the operation.

fn other_input(&self) -> Option<EdgeKind>

The edge kind for the non-dataflow inputs of the operation, not described by the signature.

fn other_output(&self) -> Option<EdgeKind>

The edge kind for the non-dataflow outputs of the operation, not described by the signature.

fn static_input(&self) -> Option<EdgeKind>

The edge kind for a single constant input of the operation, not described by the dataflow signature.

fn non_df_port_count(&self, dir: Direction) -> usize

Get the number of non-dataflow multiports.

fn substitute(&self, _subst: &Substitution<'_>) -> Self

Apply a type-level substitution to this OpType, i.e. replace type variables with new types.

impl PartialEq for Const

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticTag for Const

const TAG: OpTag = OpTag::Const

The name of the operation.

impl<'a> TryFrom<&'a OpType> for &'a Const

type Error = ()

The type returned in the event of a conversion error.

fn try_from( optype: &'a OpType, ) -> Result<&'a Const, <&'a Const as TryFrom<&'a OpType>>::Error>

Performs the conversion.

impl TryInto<Const> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Const, <OpType as TryInto<Const>>::Error>

Performs the conversion.

impl ValidateOp for Const

fn validity_flags<N>(&self) -> OpValidityFlags<N>

where N: HugrNode,

Returns a set of flags describing the validity predicates for this operation.

fn validate_op_children<'a, N>( &self, _children: impl DoubleEndedIterator<Item = (N, &'a OpType)>, ) -> Result<(), ChildrenValidationError<N>>

where N: HugrNode,

Validate the ordered list of children.

impl StructuralPartialEq for Const