germ 0.5.1

The Ultimate Gemini Toolkit.
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

//! Convert Gemtext into many types of markup.

use crate::ast::Ast;

mod html;
mod markdown;

#[cfg(feature = "macros")] mod macros;

fn safe_link_target(target: &str) -> bool {
  if target.is_empty()
    || target.chars().any(|character| {
      character.is_whitespace() || character.is_control() || character == '\\'
    })
  {
    return false;
  }

  match target.find([':', '/', '?', '#']) {
    Some(index) if target.as_bytes()[index] == b':' => matches!(
      target[..index].to_ascii_lowercase().as_str(),
      "gemini" | "gopher" | "http" | "https" | "mailto" | "ftp"
    ),
    _ => true,
  }
}

/// The available Gemtext conversion targets.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum Target {
  /// Converts Gemtext to HTML. Links outside the Gemini, Gopher, HTTP, HTTPS,
  /// mailto, and FTP schemes are rendered as text.
  HTML,
  /// Converts Gemtext to Markdown with the same link scheme policy as HTML.
  Markdown,
}

/// Converts a Gemtext AST into another markup format.
///
/// # Example
///
/// ```rust
/// use germ::convert;
///
/// let _ = convert::from_ast(
///   &germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#),
///   &convert::Target::HTML,
/// );
/// ```
#[must_use]
pub fn from_ast(source: &Ast, target: &Target) -> String {
  match target {
    Target::Markdown => markdown::convert(source.inner()),
    Target::HTML => html::convert(source.inner()),
  }
}

/// Converts raw Gemtext into another markup format.
///
/// # Example
///
/// ```rust
/// use germ::convert;
///
/// let _ = convert::from_string(
///   r#"=> gemini://gem.rest/ GemRest"#,
///   &convert::Target::HTML,
/// );
/// ```
#[must_use]
pub fn from_string(source: impl AsRef<str>, target: &Target) -> String {
  from_ast(&Ast::from_string(source), target)
}