taml 0.0.11

A kind-to-humans configuration language.
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

#![doc(html_root_url = "https://docs.rs/taml/0.0.11")]
#![warn(clippy::pedantic)]
#![allow(clippy::result_unit_err)]
#![allow(
	clippy::semicolon_if_nothing_returned,
	clippy::trivially_copy_pass_by_ref
)]

use cervine::Cow;
use core::{fmt::Debug, ops::Range};
use smartstring::alias::String;

#[cfg(doctest)]
pub mod readme {
	doc_comment::doctest!("../README.md");
}

pub mod diagnostics;
pub mod formatting;
pub mod parsing;
mod token;

pub use parsing::parse;
pub use token::Token;

/// Shared variant payload data structure for data literals (`<…:…>`).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DataLiteral<'a, Position> {
	pub encoding: Cow<'a, String, str>,
	pub encoding_span: Range<Position>,
	pub unencoded_data: Cow<'a, String, str>,
	pub unencoded_data_span: Range<Position>,
}

/// Implemented by types usable as `Position` generic type parameter in this library.
pub trait Position: Debug + Clone + Default + PartialEq {
	/// Adds `self` to both limits of `local_range` and returns the result in [`Some`].  
	/// If this operation does not make sense, [`None`] is returned instead.
	fn offset_range(&self, local_range: Range<usize>) -> Option<Range<Self>>;
}

impl Position for usize {
	fn offset_range(&self, local_range: Range<usize>) -> Option<Range<Self>> {
		Some(self + local_range.start..self + local_range.end)
	}
}

impl Position for () {
	fn offset_range(&self, _local_range: Range<usize>) -> Option<Range<Self>> {
		None
	}
}

pub use smartstring::validate;