Struct starlark::values::docs::Function

pub struct Function {
    pub docs: Option<DocString>,
    pub params: Vec<Param>,
    pub ret: Return,
}

Documents a single function.

Fields

docs: Option<DocString>

Documentation for the function. If parsed, this should generally be the first statement of a function’s body if that statement is a string literal. Any sections like “Args:”, “Returns”, etc are kept intact. It is up to the consumer to remove these sections if they are present.

params: Vec<Param>

The parameters that this function takes. Docs for these parameters should generally be extracted from the main docstring’s details.

ret: Return

Details about what this function returns.

Implementations

impl Function

pub fn from_docstring<F: FnOnce(HashMap<String, Option<DocString>>) -> Vec<Param>>(
    kind: DocStringKind,
    params_producer: F,
    return_type: Option<Type>,
    raw_docstring: Option<&str>
) -> Self

Parses function documentation out of a docstring

Arguments

• kind: The kind of docstring. This determines the formatting that is parsed.
• params_producer: A function that takes a mapping of parameter names -> docstrings, and creates a vec of params. These are then returned in the main Function object.
• return_type: The return type. This is pulled from typing info / directly from users, so it cannot be inferred generically.
• raw_docstring: The raw docstring to be parsed and potentially modified, removing the sections detailing arguments and return values. The format is determined by kind.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Function

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Function> for Function

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Function

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Function