Skip to main content

FunctionRegistration

Struct FunctionRegistration 

Source
pub struct FunctionRegistration {
    pub rust_symbol: &'static str,
    pub excel_name: &'static str,
    pub signature: FunctionSignature,
    pub category: Option<&'static str>,
    pub description: Option<&'static str>,
    pub argument_names: &'static [&'static str],
    pub argument_descriptions: &'static [&'static str],
    pub flags: FunctionFlags,
}
Expand description

Complete static registration metadata for one worksheet function.

Fields§

§rust_symbol: &'static str

Unmangled Rust-export thunk name.

§excel_name: &'static str

Excel-visible worksheet-function name.

§signature: FunctionSignature

Result and parameter type codes.

§category: Option<&'static str>

Optional Excel category.

§description: Option<&'static str>

Optional Excel-visible function description.

§argument_names: &'static [&'static str]

Excel-visible parameter names excluding the internal async handle.

§argument_descriptions: &'static [&'static str]

Excel-visible parameter help, parallel to Self::argument_names.

§flags: FunctionFlags

Registration modifiers.

Implementations§

Source§

impl FunctionRegistration

Source

pub const fn is_asynchronous(&self) -> bool

Returns whether this descriptor has the verified async >/X shape.

Source

pub const fn new( rust_symbol: &'static str, excel_name: &'static str, signature: FunctionSignature, ) -> Self

Creates function metadata with no optional category, help, or modifiers.

Source

pub const fn category(self, category: &'static str) -> Self

Adds the Excel category.

Source

pub const fn description(self, description: &'static str) -> Self

Adds Excel-visible function help text.

Source

pub const fn arguments( self, names: &'static [&'static str], descriptions: &'static [&'static str], ) -> Self

Adds parameter names and matching Excel-visible help text.

Source

pub const fn flags(self, flags: FunctionFlags) -> Self

Sets registration modifiers after validating them with Self::validate.

Source

pub fn type_text(&self) -> Result<String, RegistrationError>

Builds canonical Excel registration type text after validation.

Source

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

Validates names, argument metadata, modifiers, and async shape.

Trait Implementations§

Source§

impl Clone for FunctionRegistration

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FunctionRegistration

Source§

impl Debug for FunctionRegistration

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.