mirror of
https://github.com/YGGverse/ggemini.git
synced 2026-03-31 09:05:45 +00:00
77 lines
No EOL
2 KiB
Markdown
77 lines
No EOL
2 KiB
Markdown
# ggemini
|
|
|
|
|
|
[](https://docs.rs/ggemini)
|
|
[](https://crates.io/crates/ggemini)
|
|
|
|
Glib/Gio-oriented network API for [Gemini protocol](https://geminiprotocol.net/)
|
|
|
|
> [!IMPORTANT]
|
|
> Project in development!
|
|
>
|
|
|
|
GGemini (or G-Gemini) library written as the client extension for [Yoda](https://github.com/YGGverse/Yoda), it also could be useful for other GTK-based applications dependent of [glib](https://crates.io/crates/glib) / [gio](https://crates.io/crates/gio) (`2.66+`) backend.
|
|
|
|
## Requirements
|
|
|
|
<details>
|
|
<summary>Debian</summary>
|
|
<pre>
|
|
sudo apt install libglib2.0-dev</pre>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Fedora</summary>
|
|
<pre>
|
|
sudo dnf install glib2-devel</pre>
|
|
</details>
|
|
|
|
## Install
|
|
|
|
```
|
|
cargo add ggemini
|
|
```
|
|
|
|
## Usage
|
|
|
|
* [Documentation](https://docs.rs/ggemini/latest/ggemini/)
|
|
|
|
### Example
|
|
|
|
``` rust
|
|
use gio::*;
|
|
use glib::*;
|
|
|
|
use ggemini::client::{
|
|
connection::{request::{Mode, Request}, Response},
|
|
Client,
|
|
};
|
|
|
|
fn main() -> ExitCode {
|
|
Client::new().request_async(
|
|
Request::Gemini { // or `Request::Titan`
|
|
uri: Uri::parse("gemini://geminiprotocol.net/", UriFlags::NONE).unwrap(),
|
|
mode: Mode::HeaderOnly // handle content separately (based on MIME)
|
|
},
|
|
Priority::DEFAULT,
|
|
Cancellable::new(),
|
|
None, // optional auth `GTlsCertificate`
|
|
None, // optional TOFU `GTlsCertificate` array
|
|
|result| match result {
|
|
Ok((response, _connection)) => match response {
|
|
Response::Success(success) => match success.mime().unwrap().as_str() {
|
|
"text/gemini" => todo!(),
|
|
_ => todo!(),
|
|
},
|
|
_ => todo!(),
|
|
},
|
|
Err(_) => todo!(),
|
|
},
|
|
);
|
|
ExitCode::SUCCESS
|
|
}
|
|
```
|
|
|
|
## Other crates
|
|
|
|
* [ggemtext](https://github.com/YGGverse/ggemtext) - Glib-oriented Gemtext API |