An RPC server and client for ftml calls. See the relevant crate documentation for more information on "Foundation Text Markup Language".
Currently it does not connect to a DEEPWELL server for necessary external information (other pages, users, etc.), but will in the future.
The lint #![forbid(unsafe_code)] is set, and therefore this crate has only safe code. However dependencies may have unsafe internals.
Available under the terms of the GNU Affero General Public License. See LICENSE.md.
This crate targets the latest stable Rust. At time of writing, that is 1.43.0
$ cargo build --release
$ cargo run --release -- [arguments] # serverIf you wish to use its client, import the crate and use it as a library.
All errors are transmitted as Err(String).
The current API provided by the RPC server is as follows:
Miscellaneous:
/// Returns the static protocol version, Currently "0".
async fn protocol() -> String;
/// Determines if the server is reachable.
async fn ping() -> String;
/// Returns the system time on the server.
/// It may be in any timezone and is not monotonic.
async fn time() -> f64;Core methods:
Preprocesses the text prior to parsing or rendering. This will load any includes or perform typographic transformations. See ftml Usage for more information.
async fn prefilter(input: String) -> Result<String, String>;Prefilters and then parses the input string, returning a JSON object corresponding to the syntax tree.
This is currently not typed in code, but follows the object pattern in ftml's SyntaxTree.
async fn parse(input: String) -> Result<String, String>;Prefilters, parses, and renders the page into HTML. The definition of the HtmlOutput object is available
here, though most notable are
the html field containing partial HTML (i.e. not including tags like <html> or <body>), and style,
which contains any generated CSS.
The argument of type PageInfoOwned passes
in information about the article being rendered.
async fn render(page_info: PageInfoOwned, input: String) -> Result<HtmlOutput, String>;