Struct starlark::docs::Doc

pub struct Doc {
    pub id: Identifier,
    pub item: DocItem,
    pub custom_attrs: HashMap<String, String>,
}

The main structure that represents the documentation for a given symbol / module.

Fields

id: Identifier

item: DocItem

custom_attrs: HashMap<String, String>

Custom key-value pairs that are not interpreted directly by starlark, and can be used as arbitrary data for documentation tooling.

Implementations

impl Doc

pub fn named_item(name: String, item: DocItem) -> Self

pub fn render_as_code(&self) -> String

Render a starlark code representation of this documentation object.

Function bodies for these consist of a single “pass” statement, and objects are represented as structs.

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.

impl PartialEq for Doc

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

fn render_markdown_opt(&self, flavor: MarkdownFlavor) -> Option<String>

Generate markdown of the given flavor if possible. For some types, there may not be any useful documentation available.

fn render_markdown(&self, flavor: MarkdownFlavor) -> String

Convenience method that invokes RenderMarkdown::render_markdown_opt, and returns an empty string if that is None

impl Serialize for Doc

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 Doc