pub struct BuiltinMetadata {
pub name: &'static str,
pub signature: &'static str,
pub description: &'static str,
pub category: &'static str,
pub parameters: &'static [BuiltinParam],
pub return_type: &'static str,
pub example: Option<&'static str>,
}Expand description
Metadata for a builtin function, generated by proc-macro at compile time.
Uses &'static str for zero-allocation at runtime.
Fields§
§name: &'static strFunction name as exposed to Shape (e.g., “sma”, “abs”)
signature: &'static strFull signature (e.g., “sma(column: Column, period: Number) -> Column”)
description: &'static strDescription extracted from doc comments
category: &'static strCategory (e.g., “Indicator”, “Data”, “Trading”)
parameters: &'static [BuiltinParam]Parameter information
return_type: &'static strReturn type
example: Option<&'static str>Optional example code
Trait Implementations§
Source§impl Clone for BuiltinMetadata
impl Clone for BuiltinMetadata
Source§fn clone(&self) -> BuiltinMetadata
fn clone(&self) -> BuiltinMetadata
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for BuiltinMetadata
impl Debug for BuiltinMetadata
Source§impl From<&BuiltinMetadata> for FunctionInfo
impl From<&BuiltinMetadata> for FunctionInfo
Source§fn from(meta: &BuiltinMetadata) -> Self
fn from(meta: &BuiltinMetadata) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl Freeze for BuiltinMetadata
impl RefUnwindSafe for BuiltinMetadata
impl Send for BuiltinMetadata
impl Sync for BuiltinMetadata
impl Unpin for BuiltinMetadata
impl UnsafeUnpin for BuiltinMetadata
impl UnwindSafe for BuiltinMetadata
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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