Struct Func 

pub struct Func { /* private fields */ }

A mapping from argument values to a return value.

Implementations

impl Func

pub fn name(&self) -> Option<&str>

The function’s name (e.g. min).

Returns None if this is an anonymous closure.

pub fn title(&self) -> Option<&'static str>

The function’s title case name, for use in documentation (e.g. Minimum).

Returns None if this is a closure.

pub fn docs(&self) -> Option<&'static str>

Documentation for the function (as Markdown).

pub fn contextual(&self) -> Option<bool>

Whether the function is known to be contextual.

pub fn params(&self) -> impl Iterator<Item = ParamInfo>

Get details about this function’s parameters if available.

pub fn param(&self, name: &str) -> Option<ParamInfo>

Get the parameter info for a parameter with the given name if it exist.

pub fn returns(&self) -> Option<&'static CastInfo>

Get details about the function’s return type.

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

Search keywords for the function.

pub fn def_site(&self) -> Option<DefSite>

Where the function is defined in the Rust source code (only Some(_) if it is native, and even then it can be None if the function is generated, like the typed HTML API).

pub fn scope(&self) -> Option<&'static Scope>

The function’s associated scope of sub-definition.

pub fn field( &self, field: &str, sink: impl WarningSink, ) -> StrResult<&'static Value>

Get a field from this function’s scope, if possible.

pub fn to_element(&self) -> Option<Element>

Extract the element function, if it is one.

pub fn to_plugin(&self) -> Option<&PluginFunc>

Extract the plugin function, if it is one.

pub fn call<A: IntoArgs>( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, args: A, ) -> SourceResult<Value>

Call the function with the given context and arguments.

pub fn span(&self) -> Span

The function’s span.

pub fn spanned(self, span: Span) -> Self

Attach a span to this function if it doesn’t already have one.

impl Func

pub fn with(self, args: &mut Args) -> Func

Returns a new function that has the given arguments pre-applied.

pub fn where_(self, args: &mut Args) -> StrResult<Selector>

Returns a selector that filters for elements belonging to this function whose fields have the values of the given arguments.

Trait Implementations

impl Clone for Func

fn clone(&self) -> Func

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Func

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

Formats the value using the given formatter.

impl From<&'static NativeFuncData> for Func

fn from(data: &'static NativeFuncData) -> Self

Converts to this type from the input type.

impl From<Closure> for Func

fn from(closure: Closure) -> Self

Converts to this type from the input type.

impl From<Element> for Func

fn from(func: Element) -> Self

Converts to this type from the input type.

impl From<PluginFunc> for Func

fn from(func: PluginFunc) -> Self

Converts to this type from the input type.

impl FromValue for Func

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Func

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for Func

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Func

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Func

const NAME: &'static str = "function"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl PartialEq for Func

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&'static NativeFuncData> for Func

fn eq(&self, other: &&'static NativeFuncData) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Element> for Func

fn eq(&self, other: &Element) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for Func

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Func

fn repr(&self) -> EcoString

Return the debug representation of the value.