Struct Docs

pub struct Docs { /* private fields */ }

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

Implementations

impl Docs

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

pub fn from_lines<'a>(lines: impl Iterator<Item = &'a str>) -> Self

pub fn first_line(&self, 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".

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.