Skip to main content

Crate links_notation

Crate links_notation 

Source

Re-exports§

pub use reference_literal::decode_reference_literal;
pub use reference_literal::encode_reference_literal;
pub use cst::CstKind;
pub use cst::CstNode;
pub use cst::parse_lino_to_cst;
pub use cst::parse_lino_to_cst_with_config;
pub use parser_config::ParserConfig;
pub use stream_parser::ErrorLocation;
pub use stream_parser::StreamIterator;
pub use stream_parser::StreamParseError;
pub use stream_parser::StreamParser;
pub use stream_parser::StreamPosition;
pub use stream_parser::StreamReference;
pub use syntax::SyntaxReference;
pub use syntax::reference_quote;

Modules§

binary
Binary links notation version 1: packets and the marker-point LiNo mapping.
comments
Comments, and the rule that decides where one starts.
cst
The concrete syntax tree of a Links Notation document.
format_config
parser
parser_config
reference_literal
Version 1 lossless UTF-8 reference literals, with readable legacy quoting.
stream_parser
Incremental parsing for long-lived Links Notation streams.
syntax
How the references of a parsed document were written.

Macros§

lino
Procedural macro that provides compile-time validation of Links Notation syntax.

Structs§

LiNoBuilder
Builder for creating LiNo links with arbitrary number of values.
NestingTooDeep
A document that nests links deeper than the parser allows, with the position of the level that is one too deep.
SyntaxError
A syntax error, with the position in the document it was found at.

Enums§

LiNo
ParseError
Error type for Lino parsing

Constants§

VERSION
The version of this crate, taken from Cargo.toml at compile time.

Functions§

format_links
Formats a collection of LiNo links as a multi-line string. Each link is formatted on a separate line.
format_links_with_config
Formats a collection of LiNo links as a multi-line string using FormatConfig. Supports all formatting options including consecutive link grouping.
parse_lino
Reads a document, with comments.
parse_lino_to_links
Reads a document into a collection of links, with comments.
parse_lino_to_links_with_config
Reads a document into a collection of links the way config says to.
parse_lino_to_syntax_links
Reads a document into a collection of links whose references record how they were written.
parse_lino_to_syntax_links_with_config
Reads a document the way config says to into a collection of links whose references record how they were written; see parse_lino_to_syntax_links.
parse_lino_with_config
Reads a document the way config says to.

Type Aliases§

LinkBuilderDeprecated
Type alias for backward compatibility (deprecated).