syntect/
lib.rs

Help
1//! Welcome to the syntect docs.
2//!
3//! Much more info about syntect is available on the [Github Page](https://github.com/trishume/syntect).
4//!
5//! May I suggest that you start by reading the `Readme.md` file in the main repo.
6//! Once you're done with that you can look at the docs for [`parsing::SyntaxSet`]
7//! and for the [`easy`] module.
8//!
9//! Almost everything in syntect is divided up into either the [`parsing`] module
10//! for turning text into text annotated with scopes, and the [`highlighting`] module
11//! for turning annotated text into styled/colored text.
12//!
13//! Some docs have example code but a good place to look is the `syncat` example as
14//! well as the source code for the [`easy`] module in `easy.rs` as that shows how to
15//! plug the various parts together for common use cases.
16//!
17//! [`parsing::SyntaxSet`]: parsing/struct.SyntaxSet.html
18//! [`easy`]: easy/index.html
19//! [`parsing`]: parsing/index.html
20//! [`highlighting`]: highlighting/index.html
21
22#![doc(html_root_url = "https://docs.rs/syntect/5.2.0")]
23
24#[cfg(test)]
25#[macro_use]
26extern crate pretty_assertions;
27
28#[cfg(any(feature = "dump-load", feature = "dump-create"))]
29pub mod dumps;
30#[cfg(feature = "parsing")]
31pub mod easy;
32#[cfg(feature = "html")]
33mod escape;
34pub mod highlighting;
35#[cfg(feature = "html")]
36pub mod html;
37pub mod parsing;
38pub mod util;
39mod utils;
40
41use std::io::Error as IoError;
42
43#[cfg(feature = "plist-load")]
44use crate::highlighting::{ParseThemeError, SettingsError};
45
46/// An error enum for all things that can go wrong within syntect.
47#[derive(Debug, thiserror::Error)]
48#[non_exhaustive]
49pub enum Error {
50    /// An error occurred while loading a syntax or theme
51    #[error("Loading error: {0}")]
52    LoadingError(#[from] LoadingError),
53    /// An error occurred while parsing
54    #[cfg(feature = "parsing")]
55    #[error("Parsing error: {0}")]
56    ParsingError(#[from] crate::parsing::ParsingError),
57    /// Scope error
58    #[error("Scope error: {0}")]
59    ScopeError(#[from] crate::parsing::ScopeError),
60    /// Formatting error
61    #[error("Formatting error: {0}")]
62    Fmt(#[from] std::fmt::Error),
63    /// IO Error
64    #[error("IO Error: {0}")]
65    Io(#[from] IoError),
66}
67
68/// Common error type used by syntax and theme loading
69#[derive(Debug, thiserror::Error)]
70#[non_exhaustive]
71pub enum LoadingError {
72    /// error finding all the files in a directory
73    #[error("error finding all the files in a directory: {0}")]
74    WalkDir(#[from] walkdir::Error),
75    /// error reading a file
76    #[error("error reading a file: {0}")]
77    Io(#[from] IoError),
78    /// a syntax file was invalid in some way
79    #[cfg(all(feature = "yaml-load", feature = "parsing"))]
80    #[error("{1}: {0}")]
81    ParseSyntax(#[source] crate::parsing::ParseSyntaxError, String),
82    /// a metadata file was invalid in some way
83    #[cfg(feature = "metadata")]
84    #[error("Failed to parse JSON")]
85    ParseMetadata(#[from] serde_json::Error),
86    /// a theme file was invalid in some way
87    #[cfg(feature = "plist-load")]
88    #[error("Invalid syntax theme")]
89    ParseTheme(#[from] ParseThemeError),
90    /// a theme's Plist syntax was invalid in some way
91    #[cfg(feature = "plist-load")]
92    #[error("Invalid syntax theme settings")]
93    ReadSettings(#[from] SettingsError),
94    /// A path given to a method was invalid.
95    /// Possibly because it didn't reference a file or wasn't UTF-8.
96    #[error("Invalid path")]
97    BadPath,
98}
syntect/lib.rs

syntect/
lib.rs
