Struct re_types_builder::Docs

pub struct Docs {
    lines: Vec<(String, String)>,
}

A high-level representation of the contents of a flatbuffer docstring.

Fields

lines: Vec<(String, String)>

All docmentation lines, including the leading tag, if any.

If the tag is the empty string, it means the line is untagged.

Each line excludes the leading space and trailing newline.

• /// COMMENT\n => ("", "COMMENT")
• /// \py COMMENT\n => ("py", "COMMENT").

Implementations

impl Docs

pub fn from_raw_docs( reporter: &Reporter, virtpath: &str, fqname: &str, docs: Option<Vector<'_, ForwardsUOffset<&str>>>, ) -> Self

pub fn from_lines<'a>( reporter: &Reporter, virtpath: &str, fqname: &str, lines: impl Iterator<Item = &'a str>, ) -> Self

pub fn first_line( &self, reporter: &Reporter, objects: &Objects, target: Target, ) -> Option<String>

Get the first line of the documentation untagged.

pub fn only_lines_tagged(&self, tag: &str) -> Vec<&str>

Get all doc lines that start with the given tag.

For instance, pass "example" to get all lines that start with "\example".

pub(crate) fn lines_for( &self, reporter: &Reporter, objects: &Objects, target: Target, ) -> Vec<String>

Get all doc lines that are untagged, or has a tag matching the given target.

For instance, pass Target::Python to get all lines that are untagged or starts with "\py".

The tagged lines (\py) are left as is, but untagged lines will have Rerun doclinks translated to the target language.

Trait Implementations

impl Clone for Docs

fn clone(&self) -> Docs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Docs

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

Formats the value using the given formatter.

impl Default for Docs

fn default() -> Docs

Returns the “default value” for a type.

impl From<Docs> for MethodDocumentation

fn from(d: Docs) -> Self

Converts to this type from the input type.