Skip to main content

SwitchFn

Struct SwitchFn 

Source
pub struct SwitchFn;
Expand description

Returns the result corresponding to the first matching candidate value.

SWITCH(expression, value1, result1, [value2, result2], ..., [default]) compares expression against each candidate from left to right.

§Remarks

  • Matching is case-insensitive for text values.
  • Numeric comparisons treat Int and Number values as compatible.
  • A trailing unmatched argument acts as the default result.
  • When no candidate matches and no default is supplied, returns #N/A.
  • Errors in expression propagate immediately.

§Examples

=SWITCH("gold","silver",1,"gold",2,0)
title: "Match a text label"
formula: '=SWITCH("gold","silver",1,"gold",2,0)'
expected: 2
title: "Fall back to default"
formula: '=SWITCH(3,1,"one",2,"two","other")'
expected: "other"
related:
  - IF
  - IFS
  - CHOOSE
faq:
  - q: "Does SWITCH compare text case-sensitively?"
    a: "No. Text comparisons are case-insensitive in this implementation."
  - q: "What happens when nothing matches?"
    a: "SWITCH returns the trailing default when provided; otherwise it returns #N/A."

[formualizer-docgen:schema:start] Name: SWITCH Type: SwitchFn Min args: 3 Max args: variadic Variadic: true Signature: SWITCH(arg1: any@scalar, arg2…: any@scalar) Arg schema: arg1{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false} Caps: PURE, SHORT_CIRCUIT [formualizer-docgen:schema:end]

Trait Implementations§

Source§

impl Debug for SwitchFn

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Function for SwitchFn

[formualizer-docgen:schema:start] Name: SWITCH Type: SwitchFn Min args: 3 Max args: variadic Variadic: true Signature: SWITCH(arg1…: any@scalar) Arg schema: arg1{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false} Caps: PURE, SHORT_CIRCUIT [formualizer-docgen:schema:end]

Source§

fn caps(&self) -> FnCaps

Capability flags for this function
Source§

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

Source§

fn min_args(&self) -> usize

Source§

fn variadic(&self) -> bool

Source§

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

Source§

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

The unified evaluation path. Read more
Source§

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

Source§

fn volatile(&self) -> bool

Source§

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).
Source§

fn dependency_contract( &self, _arity: usize, ) -> Option<FunctionDependencyContract>

Optional dependency contract for passive planning/FormulaPlane analysis. Read more
Source§

fn function_salt(&self) -> u64

Source§

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). Read more
Source§

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.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.