mirror of
https://github.com/YGGverse/ggemini.git
synced 2026-03-31 17:15:31 +00:00
42 lines
No EOL
1.1 KiB
Markdown
42 lines
No EOL
1.1 KiB
Markdown
# ggemini
|
|
|
|
Glib/Gio-oriented network library for [Gemini protocol](https://geminiprotocol.net/)
|
|
|
|
> [!IMPORTANT]
|
|
> Project in development!
|
|
>
|
|
|
|
GGemini (or G-Gemini) initially created as the client extension for [Yoda Browser](https://github.com/YGGverse/Yoda),
|
|
but also could be useful for any other integration as depends of
|
|
[glib](https://crates.io/crates/glib) and [gio](https://crates.io/crates/gio) (`v2_66`) crates only.
|
|
|
|
## Install
|
|
|
|
```
|
|
cargo add ggemini
|
|
```
|
|
|
|
## Usage
|
|
|
|
### `client`
|
|
|
|
Gio API already includes powerful [SocketClient](https://docs.gtk.org/gio/class.SocketClient.html),
|
|
`ggemini::client` just extends some features a bit, to simplify interaction with socket over Gemini Protocol.
|
|
|
|
It also contain some children components/mods bellow for low-level access any feature directly.
|
|
|
|
#### `client::buffer`
|
|
|
|
#### `client::response`
|
|
|
|
Response parser for [InputStream](https://docs.gtk.org/gio/class.InputStream.html)
|
|
|
|
#### `client::response::Response`
|
|
#### `client::response::header`
|
|
#### `client::response::body`
|
|
|
|
https://docs.gtk.org/glib/struct.Bytes.html
|
|
|
|
## See also
|
|
|
|
* [ggemtext](https://github.com/YGGverse/ggemtext) - Glib-oriented Gemtext API |