Commit86f2fa3

authored

Rollup merge of#125148 - RalfJung:codegen-sh, r=scottmcm

codegen: tweak/extend shift commentsr? `@scottmcm`

2 parents6dddc88 +17bd43c commit86f2fa3Copy full SHA for 86f2fa3

File tree

+13

-4

lines changed

+13

-4

lines changed

Lines changed: 5 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -294,12 +294,13 @@ pub fn coerce_unsized_into<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(`
`294`	`294`	`}`
`295`	`295`	`}`
`296`	`296`
`297`		-/// Returns `rhs` sufficiently masked, truncated, and/or extended so that
`298`		-/// it can be used to shift `lhs`.
	`297`	+/// Returns `rhs` sufficiently masked, truncated, and/or extended so that it can be used to shift
	`298`	+/// `lhs`: it has the same size as `lhs`, and the value, when interpreted unsigned (no matter its
	`299`	+/// type), will not exceed the size of `lhs`.
`299`	`300`	`///`
`300`		`-/// Shifts in MIR are all allowed to have mismatched LHS & RHS types.`
	`301`	`+/// Shifts in MIR are all allowed to have mismatched LHS & RHS types, and signed RHS.`
`301`	`302`	/// The shift methods in `BuilderMethods`, however, are fully homogeneous
`302`		`-/// (both parameters and the return type are all the sametype).`
	`303`	`+/// (both parameters and the return type are all the samesize) and assume an unsigned RHS.`
`303`	`304`	`///`
`304`	`305`	/// If `is_unchecked` is false, this masks the RHS to ensure it stays in-bounds,
`305`	`306`	/// as the `BuilderMethods` shifts are UB for out-of-bounds shift amounts.

Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -110,8 +110,16 @@ pub trait BuilderMethods<'a, 'tcx>:`
`110`	`110`	`fnfrem(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`
`111`	`111`	`fnfrem_fast(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`
`112`	`112`	`fnfrem_algebraic(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`
	`113`	`+/// Generate a left-shift. Both operands must have the same size. The right operand must be`
	`114`	`+/// interpreted as unsigned and can be assumed to be less than the size of the left operand.`
`113`	`115`	`fnshl(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`
	`116`	`+/// Generate a logical right-shift. Both operands must have the same size. The right operand`
	`117`	`+/// must be interpreted as unsigned and can be assumed to be less than the size of the left`
	`118`	`+/// operand.`
`114`	`119`	`fnlshr(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`
	`120`	`+/// Generate an arithmetic right-shift. Both operands must have the same size. The right operand`
	`121`	`+/// must be interpreted as unsigned and can be assumed to be less than the size of the left`
	`122`	`+/// operand.`
`115`	`123`	`fnashr(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`
`116`	`124`	`fnunchecked_sadd(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`
`117`	`125`	`fnunchecked_uadd(&mutself,lhs:Self::Value,rhs:Self::Value) ->Self::Value;`

Comments

(0)