Struct BitLShiftFn 

pub struct BitLShiftFn;

Shifts a non-negative integer left or right by a given bit count.

Positive shift_amount shifts left; negative shift_amount shifts right.

Remarks

• number must be a whole number in [0, 2^48).
• Shift values are numerically coerced; large positive shifts can return #NUM!.
• Left-shift results must remain below 2^48, or the function returns #NUM!.

Examples

title: "Shift left by two bits"
formula: "=BITLSHIFT(6,2)"
expected: 24

title: "Use negative shift to move right"
formula: "=BITLSHIFT(32,-3)"
expected: 4

related:
  - BITRSHIFT
  - BITAND
  - BITOR
faq:
  - q: "What does a negative `shift_amount` do in `BITLSHIFT`?"
    a: "Negative shifts are interpreted as right shifts, while positive shifts move bits left."

Trait Implementations

impl Debug for BitLShiftFn

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

Formats the value using the given formatter.

impl Function for BitLShiftFn

[formualizer-docgen:schema:start] Name: BITLSHIFT Type: BitLShiftFn Min args: 2 Max args: 2 Variadic: false Signature: BITLSHIFT(arg1: number@scalar, arg2: number@scalar) Arg schema: arg1{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=false}; arg2{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=false} Caps: PURE [formualizer-docgen:schema:end]

fn caps(&self) -> FnCaps

Capability flags for this function

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

fn min_args(&self) -> usize

fn arg_schema(&self) -> &'static [ArgSchema]

fn eval<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

The unified evaluation path.

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

fn variadic(&self) -> bool

fn volatile(&self) -> bool

fn aliases(&self) -> &'static [&'static str]

Optional list of additional alias names (case-insensitive) that should resolve to this function. Default: empty slice. Implementors can override to expose legacy names. Returned slice must have ’static lifetime (typically a static array reference).

fn function_salt(&self) -> u64

fn eval_reference<'a, 'b, 'c>( &self, _args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Option<Result<ReferenceType, ExcelError>>

Optional reference result path. Only called by the interpreter/engine when the callsite expects a reference (e.g., range combinators, by-ref argument positions, or spill sources).

fn dispatch<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

Dispatch to the unified evaluation path with automatic argument validation.