gemrest/germ

🦠 The Definitive Gemini Protocol Toolkit

Germ

The Ultimate Gemini Toolkit

Germ is a toolkit for the Gemini protocol which aims to have a little something for everyone. At the moment, Germ has ZERO dependencies (unless you use the request feature), and Germ will continue to try its hardest to have as few dependencies as possible.

Features

• AST builder to easily construct and manipulate AST trees from raw Gemtext
• Converters to easily convert from Gemtext to markup formats such as HTML or Markdown
• Blocking and non-blocking request suite
• Structured meta section manipulation
• And more!

Check out the rest of the features in the Features section under Usage

Usage

Current version:

# Cargo.toml

[dependencies]
# To enable only the base (default) features: ast, convert, meta, request
# germ = "*" # Use current version show above!

# To enable only certain features
[dependencies.germ]
version = "*" # Use current version show above!
default-features = false
features = ["ast"] # Enable the features you would like to use!

Features

Feature	Description
default	ast, convert, meta, request
ast	Construct AST trees from raw Gemtext
blocking	Blocking equivalent of request
convert	Convert Gemtext to markup formats such as HTML or Markdown
request	Make Gemini requests, get sane, structured results
meta	Structure-ise a Gemini response's meta section
macros	Macros to aid with various Germ-related functionalities
quick	Tiny functions to create valid Gemtext elements from structured input

Examples

Thoroughly commented examples can be found within the examples/ directory.

License

This project is licensed with the GNU General Public License v3.0.

germ's Issues

Emoji in heading messes up the level calculation

Another issue I found when using the library to access my own Gemfeed. If you have an emoji at the start of a heading, it will mess up the level calculation:

• # MyHeading => reported as heading level 1.
• # 🖊️ MyHeading => reported as heading level 0.

This seems to only happen if the emoji is at the start of the header.

Not sure if it affects level 2 or 3 headings.

Meta requires a 'static String?

I'm making good use of your library in a small project. But I can't parse the meta from a Gemini response into a structured representation, because the from_string function requires a 'static lifetime. This seems like an oversight maybe?

let resp = germ::request::request(url)?;
let meta = germ::meta::Meta::from_string(resp.meta());

This is not possible, because resp.meta() does not have a 'static lifetime. Is there a way to parse the response Meta into the struct?