An open API service indexing awesome lists of open source software.

https://github.com/yggverse/ggemini

Glib-oriented client for Gemini protocol
https://github.com/yggverse/ggemini

async client gemini gemini-protocol gio glib gtk socket titan tls

Last synced: 6 months ago
JSON representation

Glib-oriented client for Gemini protocol

Awesome Lists containing this project

README

          

# ggemini

![Build](https://github.com/YGGverse/ggemini/actions/workflows/build.yml/badge.svg)
[![Documentation](https://docs.rs/ggemini/badge.svg)](https://docs.rs/ggemini)
[![crates.io](https://img.shields.io/crates/v/ggemini.svg)](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

Debian


sudo apt install libglib2.0-dev

Fedora


sudo dnf install glib2-devel

## 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 `GTlsCertificate`
|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