Struct starlark::docs::DocFunction

pub struct DocFunction {
    pub docs: Option<DocString>,
    pub params: Vec<DocParam>,
    pub ret: DocReturn,
    pub as_type: Option<Ty>,
}

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<DocParam>

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

ret: DocReturn

Details about what this function returns.

as_type: Option<Ty>

Does this function act as type?

Implementations

impl DocFunction

pub fn find_param_with_name(&self, param_name: &str) -> Option<&DocParam>

Used by LSP.

pub fn from_docstring( kind: DocStringKind, params: Vec<DocParam>, return_type: Ty, raw_docstring: Option<&str>, as_type: Option<Ty> ) -> Self

Parses function documentation out of a docstring

Arguments

• kind: The kind of docstring. This determines the formatting that is parsed.
• params: The parameters of the function.
• 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 Allocative for DocFunction

fn visit<'allocative_a, 'allocative_b: 'allocative_a>( &self, visitor: &'allocative_a mut Visitor<'allocative_b> )

impl Clone for DocFunction

fn clone(&self) -> DocFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocFunction

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

Formats the value using the given formatter.

impl Default for DocFunction

fn default() -> DocFunction

Returns the “default value” for a type.

impl PartialEq for DocFunction

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

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

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

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

impl Serialize for DocFunction

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 DocFunction