Struct UtilityFn 

pub struct UtilityFn {
    pub name: String,
    pub params: Vec<Param>,
    pub return_ty: TyRef,
    pub is_vararg: bool,
    pub category: String,
    pub doc: Option<DocId>,
}

A @GlobalScope utility function (sin, print, range, …).

Fields

name: String

The function name.

params: Vec<Param>

The parameters, in order.

return_ty: TyRef

The return type.

is_vararg: bool

Accepts a variable number of trailing arguments.

category: String

The JSON category (math, random, general).

doc: Option<DocId>

Documentation handle, when the doc store is populated.

Trait Implementations

impl Archive for UtilityFn

where String: Archive, Vec<Param>: Archive, TyRef: Archive, bool: Archive, Option<DocId>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedUtilityFn

The archived representation of this type.

type Resolver = UtilityFnResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for UtilityFn

fn clone(&self) -> UtilityFn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UtilityFn

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

Formats the value using the given formatter.

impl<__D: Fallible + ?Sized> Deserialize<UtilityFn, __D> for Archived<UtilityFn>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, Vec<Param>: Archive, <Vec<Param> as Archive>::Archived: Deserialize<Vec<Param>, __D>, TyRef: Archive, <TyRef as Archive>::Archived: Deserialize<TyRef, __D>, bool: Archive, <bool as Archive>::Archived: Deserialize<bool, __D>, Option<DocId>: Archive, <Option<DocId> as Archive>::Archived: Deserialize<Option<DocId>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<UtilityFn, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Eq for UtilityFn

impl PartialEq for UtilityFn

fn eq(&self, other: &UtilityFn) -> 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<__S: Fallible + ?Sized> Serialize<__S> for UtilityFn

where String: Serialize<__S>, Vec<Param>: Serialize<__S>, TyRef: Serialize<__S>, bool: Serialize<__S>, Option<DocId>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl StructuralPartialEq for UtilityFn