Struct LemmyHelp

pub struct LemmyHelp { /* private fields */ }

Implementations

impl LemmyHelp

pub fn new() -> Self

Creates a new parser instance

use lemmy_help::LemmyHelp;

LemmyHelp::new();

pub fn parse(&mut self, src: &str) -> Result<&Self, Vec<Simple<TagType>>>

Parse given lua source code to generate AST representation

use lemmy_help::{LemmyHelp, Nodes};

let mut lemmy = LemmyHelp::default();
let src = r#"
local U = {}

---Add two integar and print it
---@param this number First number
---@param that number Second number
function U.sum(this, that)
    print(this + that)
end

return U
"#;

let ast = lemmy.parse(&src).unwrap();
assert!(!ast.nodes().is_empty());

pub fn for_help( &mut self, src: &str, settings: &Settings, ) -> Result<&Self, Vec<Simple<TagType>>>

Similar to LemmyHelp::parse, but specifically used for generating vimdoc

Trait Implementations

impl<T: FromEmmy> AsDoc<T> for LemmyHelp

fn as_doc(&self, s: &T::Settings) -> T

impl Debug for LemmyHelp

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

Formats the value using the given formatter.

impl Default for LemmyHelp

fn default() -> LemmyHelp

Returns the “default value” for a type.

impl Nodes for LemmyHelp

fn nodes(&self) -> &Vec<Node>