ggemtext 0.7.0

Glib-oriented Gemtext API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

# ggemtext

![Build](https://github.com/YGGverse/ggemtext/actions/workflows/build.yml/badge.svg)
[![Documentation](https://docs.rs/ggemtext/badge.svg)](https://docs.rs/ggemtext)
[![crates.io](https://img.shields.io/crates/v/ggemtext.svg)](https://crates.io/crates/ggemtext)

Glib-oriented [Gemtext](https://geminiprotocol.net/docs/gemtext.gmi) API

## Install

``` bash
cargo add ggemtext
```

## Usage

* [Documentation](https://docs.rs/ggemtext/latest/)

### Line

Line parser, useful for [TextTag](https://docs.gtk.org/gtk4/class.TextTag.html) operations in [TextBuffer](https://docs.gtk.org/gtk4/class.TextBuffer.html) context.

Iterate Gemtext lines to continue with [Line](#Line) API:

``` rust
for line in gemtext.lines() {
    // ..
}
```

#### Code

``` rust
use ggemtext::line::Code;
match Code::begin_from("```alt") {
    Some(mut code) => {
        assert!(code.continue_from("line 1").is_ok());
        assert!(code.continue_from("line 2").is_ok());
        assert!(code.continue_from("```").is_ok()); // complete

        assert!(code.is_completed);
        assert_eq!(code.alt, Some("alt".into()));
        assert_eq!(code.value.len(), 12 + 2); // +NL
    }
    None => unreachable!(),
}
```

#### Header

**Struct**

``` rust
use ggemtext::line::{Header, header::Level};
match Header::parse("# H1") {
    Some(h1) => {
        assert_eq!(h1.level as u8, Level::H1 as u8);
        assert_eq!(h1.value, "H1");
    }
    None => unreachable!(),
} // H1, H2, H3
```

**Trait**

``` rust
use ggemtext::line::header::{Gemtext, Level};
assert_eq!("# H1".as_value(), Some("H1"));
assert_eq!("H1".to_source(&Level::H1), "# H1");
// H1, H2, H3
```

#### Link

``` rust
use ggemtext::line::Link;

const SOURCE: &str = "=> gemini://geminiprotocol.net 1965-01-19 Gemini";

let link = Link::parse(SOURCE).unwrap();

assert_eq!(link.alt, Some("1965-01-19 Gemini".to_string()));
assert_eq!(link.url, "gemini://geminiprotocol.net");

let uri = link.uri(None).unwrap();
assert_eq!(uri.scheme(), "gemini");
assert_eq!(uri.host().unwrap(), "geminiprotocol.net");

let time = link.time(Some(&glib::TimeZone::local())).unwrap();
assert_eq!(time.year(), 1965);
assert_eq!(time.month(), 1);
assert_eq!(time.day_of_month(), 19);

assert_eq!(link.to_source(), SOURCE);
```

#### List

**Struct**

``` rust
use ggemtext::line::List;
match List::parse("* Item") {
    Some(list) => assert_eq!(list.value, "Item"),
    None => unreachable!(),
}
```

**Trait**

``` rust
use ggemtext::line::list::Gemtext;
assert_eq!("* Item".as_value(), Some("Item"))
assert_eq!("Item".to_source(), "* Item")
```

#### Quote

**Struct**

``` rust
use ggemtext::line::Quote;
match Quote::parse("> Quote") {
    Some(quote) => assert_eq!(quote.value, "Quote"),
    None => unreachable!(),
}
```

**Trait**

``` rust
use ggemtext::line::quote::Gemtext;
assert_eq!("> Quote".as_value(), Some("Quote"))
assert_eq!("Quote".to_source(), "> Quote")
```

## Integrations

* [Yoda](https://github.com/YGGverse/Yoda) - Browser for Gemini Protocol

## See also

* [ggemini](https://github.com/YGGverse/ggemini) - Glib-oriented client for Gemini Protocol