Struct Yield

Source

pub struct Yield { /* private fields */ }

Expand description

The Yield op is used in conjunction with If and While ops as a return-like terminator.

With If, its regions must be terminated with either a Yield or an [Unreachable] op.
With While, a Yield is only valid in the after region, and the yielded operands must match the region arguments of the before region. Thus to return values from the body of a loop, one must first yield them from the after region to the before region using Yield, and then yield them from the before region by passsing them as forwarded operands of the Condition op.

Any number of operands can be yielded at the same time. However, when Yield is used in conjunction with While, the arity and type of the operands must match the region arguments of the before region. When used in conjunction with If, both the if_true and if_false regions must yield the same arity and types.

Struct YieldCopy item path

Implementations§

impl Yield

pub fn create<B: ?Sized + Builder, TYielded: IntoIterator<Item = ValueRef>>( builder: &mut B, span: SourceSpan, yielded: TYielded, ) -> Result<UnsafeIntrusiveEntityRef<Self>, Report>

impl Yield

impl Yield

impl Yield

impl Yield

pub fn yielded(&self) -> OpOperandRange<'_>

pub fn yielded_mut(&mut self) -> OpOperandRangeMut<'_>

impl Yield

impl Yield

impl Yield

Trait Implementations§

impl AsMut<Operation> for Yield

fn as_mut(&mut self) -> &mut Operation

impl AsRef<Operation> for Yield

fn as_ref(&self) -> &Operation

impl<TYielded: IntoIterator<Item = ValueRef>> BuildableOp<(TYielded,)> for Yield

type Builder<'a, T: ?Sized + Builder + 'a> = YieldBuilder<'a, T>

fn builder<'b, B>(builder: &'b mut B, span: SourceSpan) -> Self::Builder<'b, B>where B: ?Sized + Builder + 'b,

impl Op for Yield

fn name(&self) -> OperationName

fn as_operation(&self) -> &Operation

fn as_operation_mut(&mut self) -> &mut Operation

fn print(&self, flags: &OpPrintingFlags) -> Document

fn as_operation_ref(&self) -> RawEntityRef<Operation, IntrusiveLink>

fn set_span(&mut self, span: SourceSpan)

fn parent(&self) -> Option<RawEntityRef<Block, IntrusiveLink>>

fn parent_region(&self) -> Option<RawEntityRef<Region, IntrusiveLink>>

fn parent_op(&self) -> Option<RawEntityRef<Operation, IntrusiveLink>>

fn num_regions(&self) -> usize

fn regions(&self) -> &EntityList<Region>

fn regions_mut(&mut self) -> &mut EntityList<Region>

fn region(&self, index: usize) -> EntityRef<'_, Region>

fn region_mut(&mut self, index: usize) -> EntityMut<'_, Region>

fn has_successors(&self) -> bool

fn num_successors(&self) -> usize

fn has_operands(&self) -> bool

fn num_operands(&self) -> usize

fn operands(&self) -> &EntityStorage<RawEntityRef<OpOperandImpl, IntrusiveLink>>

fn operands_mut( &mut self, ) -> &mut EntityStorage<RawEntityRef<OpOperandImpl, IntrusiveLink>>

fn has_results(&self) -> bool

fn num_results(&self) -> usize

fn results(&self) -> &EntityStorage<RawEntityRef<OpResult>>

fn results_mut(&mut self) -> &mut EntityStorage<RawEntityRef<OpResult>>

fn successors(&self) -> &EntityStorage<SuccessorInfo, 0>

fn successors_mut(&mut self) -> &mut EntityStorage<SuccessorInfo, 0>

impl OpRegistration for Yield

fn dialect_name() -> Symbol

fn name() -> Symbol

fn traits() -> Box<[TraitInfo]>

fn full_name() -> Symbol

impl OpVerifier for Yield

fn verify(&self, context: &Context) -> Result<(), Report>

impl RegionBranchTerminatorOpInterface for Yield

fn get_successor_operands( &self, _point: RegionBranchPoint, ) -> SuccessorOperandRange<'_>

fn get_mutable_successor_operands( &mut self, _point: RegionBranchPoint, ) -> SuccessorOperandRangeMut<'_>

fn get_successor_regions( &self, _operands: &[Option<Box<dyn AttributeValue>>], ) -> SmallVec<[RegionSuccessorInfo; 2]>

impl Spanned for Yield

fn span(&self) -> SourceSpan

impl ReturnLike for Yield

impl Terminator for Yield

Auto Trait Implementations§

impl !Freeze for Yield

impl !RefUnwindSafe for Yield

impl !Send for Yield

impl !Sync for Yield

impl Unpin for Yield

impl !UnwindSafe for Yield

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Canonicalizable for Twhere T: Op,

default fn get_canonicalization_patterns( _rewrites: &mut RewritePatternSet, _context: Rc<Context>, )

impl<T> Conv for T

Struct Yield

fn builder<'b, B>(builder: &'b mut B, span: SourceSpan) -> Self::Builder<'b, B>
where B: ?Sized + Builder + 'b,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> Canonicalizable for T
where T: Op,

fn conv<T>(self) -> T
where Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> OpExt for T
where T: Op + ?Sized,

fn nearest_parent_op<U>(&self) -> Option<RawEntityRef<U, IntrusiveLink>>
where U: Op,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,