YGGverse/ggemini
1
0
Fork 0
mirror of https://github.com/YGGverse/ggemini.git synced 2026-03-31 09:05:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
yggverse 2024-10-25 16:14:53 +03:00
parent afc030420b
commit 052003b6be
1 changed files with 57 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -6,6 +6,63 @@ Glib-oriented client for [Gemini protocol](https://geminiprotocol.net/)
> Project in development!
>
## Install
```
cargo add ggemini
```
## Usage
## `client`
#### `client::simple_socket_request_async`
High-level API to make async socket request and auto-close connection on complete.
Return [Response](#client::response::Response) on success or [Error](#client::Error) enum on failure.
``` rust
use glib::{Uri, UriFlags};
match Uri::parse("gemini://geminiprotocol.net/", UriFlags::NONE) {
// Begin async request
Ok(uri) => ggemini::client::simple_socket_request_async(uri, |response| match response {
// Process response
Ok(response) => {
// Expect success status
assert!(match response.header().status() {
Some(ggemini::client::response::header::Status::Success) => true,
_ => false,
})
}
Err(_) => assert!(false),
}),
Err(_) => assert!(false),
}
```
#### `client::Error`
#### `client::response`
#### `client::response::Response`
#### `client::response::header`
#### `client::response::header::meta`
#### `client::response::header::mime`
#### `client::response::header::status`
#### `client::response::header::language`
#### `client::response::header::charset`
#### `client::response::body`
#### `client::socket`
#### `client::socket::connection`
#### `client::socket::connection::input`
#### `client::socket::connection::input::buffer`
#### `client::socket::connection::output`
## Integrations
* [Yoda](https://github.com/YGGverse/Yoda) - Browser for Gemini Protocol