Enum starlark::docs::DocParam

pub enum DocParam {
    Arg {
        name: String,
        docs: Option<DocString>,
        typ: Ty,
        default_value: Option<String>,
    },
    NoArgs,
    OnlyPosBefore,
    Args {
        name: String,
        docs: Option<DocString>,
        typ: Ty,
    },
    Kwargs {
        name: String,
        docs: Option<DocString>,
        typ: Ty,
    },
}

A single parameter of a function.

Variants

Arg

Fields

name: String

docs: Option<DocString>

typ: Ty

default_value: Option<String>

If present, this parameter has a default value. This is the repr() of that value.

A regular parameter that may or may not have a default value.

NoArgs

Represents the “*” argument.

OnlyPosBefore

Represents the “/” argument from PEP 570.

Args

Fields

name: String

docs: Option<DocString>

typ: Ty

Represents the “*args” style of argument.

Kwargs

Fields

name: String

docs: Option<DocString>

typ: Ty

Represents the “**kwargs” style of argument.

Implementations

impl DocParam

pub fn get_doc_string(&self) -> Option<&DocString>

Get the underlying DocString for this item, if it exists.

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

Get the summary of the underlying DocString for this item, if it exists.

Trait Implementations

impl Allocative for DocParam

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

impl Clone for DocParam

fn clone(&self) -> DocParam

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocParam

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

Formats the value using the given formatter.

impl PartialEq for DocParam

fn eq(&self, other: &DocParam) -> 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 DocParam

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 DocParam