14713678285

Committed 28 Apr 2025 04:51PM UTC coverage: 85.011% (-0.1%) from 85.112%

Build # 14713678285

Build Type

push

github

Committed by

Ortham

Commit Message

Update changelogs and versions for 6.1.3

Run Details

3471 of 4083 relevant lines covered (85.01%)

34.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

28.36

/src/error.rs

/*
 * This file is part of esplugin
 *
 * Copyright (C) 2017 Oliver Hamlet
 *
 * esplugin is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * esplugin is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with esplugin. If not, see <http://www.gnu.org/licenses/>.
 */

use std::error;
use std::fmt;
use std::io;
use std::num::NonZeroUsize;
use std::path::Path;
use std::path::PathBuf;
use std::slice::EscapeAscii;

use nom::Err;

#[expect(clippy::error_impl_error)]
#[derive(Debug)]
pub enum Error {
    IoError(io::Error),
    NoFilename(PathBuf),
    ParsingIncomplete(MoreDataNeeded),
    ParsingError(Box<[u8]>, ParsingErrorKind),
    DecodeError(Box<[u8]>),
    UnresolvedRecordIds(PathBuf),
    PluginMetadataNotFound(String),
}

impl From<Err<nom::error::Error<&[u8]>>> for Error {
    fn from(error: Err<nom::error::Error<&[u8]>>) -> Self {
        match error {
            Err::Incomplete(nom::Needed::Unknown) => {
                Error::ParsingIncomplete(MoreDataNeeded::UnknownSize)
            }
            Err::Incomplete(nom::Needed::Size(size)) => {
                Error::ParsingIncomplete(MoreDataNeeded::Size(size))
            }
            Err::Error(err) | Err::Failure(err) => Error::ParsingError(
                err.input.into(),
                ParsingErrorKind::GenericParserError(err.code.description().to_owned()),
            ),
        }
    }
}

impl From<io::Error> for Error {
    fn from(error: io::Error) -> Self {
        Error::IoError(error)
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Error::IoError(x) => x.fmt(f),
            Error::NoFilename(path) => {
                write!(
                    f,
                    "The plugin path \"{}\" has no filename part",
                    escape_ascii(path)
                )
            }
            Error::ParsingIncomplete(MoreDataNeeded::UnknownSize) => write!(
                f,
                "An unknown number of bytes of additional input was expected by the plugin parser"
            ),
            Error::ParsingIncomplete(MoreDataNeeded::Size(size)) => write!(
                f,
                "{size} bytes of additional input was expected by the plugin parser"
            ),
            Error::ParsingError(input, kind) => write!(
                f,
                "An error was encountered while parsing the plugin content \"{}\": {kind}",
                input.escape_ascii()
            ),
            Error::DecodeError(bytes) => write!(
                f,
                "Plugin string content could not be decoded from Windows-1252, content is \"{}\"",
                bytes.escape_ascii()
            ),
            Error::UnresolvedRecordIds(path) => {
                write!(
                    f,
                    "Record IDs are unresolved for plugin at \"{}\"",
                    escape_ascii(path)
                )
            }
            Error::PluginMetadataNotFound(plugin) => {
                write!(f, "Plugin metadata for \"{plugin}\" not found")
            }
        }
    }
}

impl error::Error for Error {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            Error::IoError(x) => Some(x),
            _ => None,
        }
    }
}

fn escape_ascii(path: &Path) -> EscapeAscii {
    path.as_os_str().as_encoded_bytes().escape_ascii()
}

#[derive(Debug)]
pub enum ParsingErrorKind {
    /// The `Vec<u8>` field is the expected record type.
    UnexpectedRecordType(Vec<u8>),
    /// The usize field is the expected minimum data length.
    SubrecordDataTooShort(usize),
    /// The String field is the name of the parser that errored.
    GenericParserError(String),
}

impl fmt::Display for ParsingErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            ParsingErrorKind::UnexpectedRecordType(v) => {
                write!(f, "Expected record type \"{}\"", v.escape_ascii())
            }
            ParsingErrorKind::SubrecordDataTooShort(s) => write!(
                f,
                "Subrecord data field too short, expected at least {s} bytes",
            ),
            ParsingErrorKind::GenericParserError(e) => write!(f, "Error in parser: {e}"),
        }
    }
}

#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum MoreDataNeeded {
    /// It's not known how much more data are needed
    UnknownSize,
    /// Contains the number of bytes of data that are needed
    Size(NonZeroUsize),
}

1	/*
2	* This file is part of esplugin
3	*
4	* Copyright (C) 2017 Oliver Hamlet
5	*
6	* esplugin is free software: you can redistribute it and/or modify
7	* it under the terms of the GNU General Public License as published by
8	* the Free Software Foundation, either version 3 of the License, or
9	* (at your option) any later version.
10	*
11	* esplugin is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with esplugin. If not, see <http://www.gnu.org/licenses/>.
18	*/
19
20	use std::error;
21	use std::fmt;
22	use std::io;
23	use std::num::NonZeroUsize;
24	use std::path::Path;
25	use std::path::PathBuf;
26	use std::slice::EscapeAscii;
27
28	use nom::Err;
29
30	#[expect(clippy::error_impl_error)]
31	#[derive(Debug)]
32	pub enum Error {
33	IoError(io::Error),
34	NoFilename(PathBuf),
35	ParsingIncomplete(MoreDataNeeded),
36	ParsingError(Box<[u8]>, ParsingErrorKind),
37	DecodeError(Box<[u8]>),
38	UnresolvedRecordIds(PathBuf),
39	PluginMetadataNotFound(String),
40	}
41
42	impl From<Err<nom::error::Error<&[u8]>>> for Error {
43	fn from(error: Err<nom::error::Error<&[u8]>>) -> Self {	×
44	match error {	×
45	Err::Incomplete(nom::Needed::Unknown) => {
46	Error::ParsingIncomplete(MoreDataNeeded::UnknownSize)	×
47	}
48	Err::Incomplete(nom::Needed::Size(size)) => {	×
49	Error::ParsingIncomplete(MoreDataNeeded::Size(size))	×
50	}
51	Err::Error(err) \| Err::Failure(err) => Error::ParsingError(	×
52	err.input.into(),	×
53	ParsingErrorKind::GenericParserError(err.code.description().to_owned()),	×
54	),	×
55	}
56	}	×
57	}
58
59	impl From<io::Error> for Error {
60	fn from(error: io::Error) -> Self {	1✔
61	Error::IoError(error)	1✔
62	}	1✔
63	}
64
65	impl fmt::Display for Error {
66	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {	5✔
67	match self {	×
68	Error::IoError(x) => x.fmt(f),	×
69	Error::NoFilename(path) => {	×
70	write!(	×
71	f,	×
72	"The plugin path \"{}\" has no filename part",	×
73	escape_ascii(path)	×
74	)	×
75	}
76	Error::ParsingIncomplete(MoreDataNeeded::UnknownSize) => write!(	×
77	f,	×
78	"An unknown number of bytes of additional input was expected by the plugin parser"	×
79	),	×
80	Error::ParsingIncomplete(MoreDataNeeded::Size(size)) => write!(	×
81	f,	×
82	"{size} bytes of additional input was expected by the plugin parser"	×
83	),	×
84	Error::ParsingError(input, kind) => write!(	5✔
85	f,	5✔
86	"An error was encountered while parsing the plugin content \"{}\": {kind}",	5✔
87	input.escape_ascii()	5✔
88	),	5✔
89	Error::DecodeError(bytes) => write!(	×
90	f,	×
91	"Plugin string content could not be decoded from Windows-1252, content is \"{}\"",	×
92	bytes.escape_ascii()	×
93	),	×
94	Error::UnresolvedRecordIds(path) => {	×
95	write!(	×
96	f,	×
97	"Record IDs are unresolved for plugin at \"{}\"",	×
98	escape_ascii(path)	×
99	)	×
100	}
101	Error::PluginMetadataNotFound(plugin) => {	×
102	write!(f, "Plugin metadata for \"{plugin}\" not found")	×
103	}
104	}
105	}	5✔
106	}
107
108	impl error::Error for Error {
109	fn source(&self) -> Option<&(dyn error::Error + 'static)> {	×
110	match self {	×
111	Error::IoError(x) => Some(x),	×
112	_ => None,	×
113	}
114	}	×
115	}
116
117	fn escape_ascii(path: &Path) -> EscapeAscii {	×
118	path.as_os_str().as_encoded_bytes().escape_ascii()	×
119	}	×
120
121	#[derive(Debug)]
122	pub enum ParsingErrorKind {
123	/// The `Vec<u8>` field is the expected record type.
124	UnexpectedRecordType(Vec<u8>),
125	/// The usize field is the expected minimum data length.
126	SubrecordDataTooShort(usize),
127	/// The String field is the name of the parser that errored.
128	GenericParserError(String),
129	}
130
131	impl fmt::Display for ParsingErrorKind {
132	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {	5✔
133	match self {	5✔
134	ParsingErrorKind::UnexpectedRecordType(v) => {	4✔
135	write!(f, "Expected record type \"{}\"", v.escape_ascii())	4✔
136	}
137	ParsingErrorKind::SubrecordDataTooShort(s) => write!(	1✔
138	f,	1✔
139	"Subrecord data field too short, expected at least {s} bytes",	1✔
140	),	1✔
141	ParsingErrorKind::GenericParserError(e) => write!(f, "Error in parser: {e}"),	×
142	}
143	}	5✔
144	}
145
146	#[derive(Debug, PartialEq, Eq, Clone, Copy)]
147	pub enum MoreDataNeeded {
148	/// It's not known how much more data are needed
149	UnknownSize,
150	/// Contains the number of bytes of data that are needed
151	Size(NonZeroUsize),
152	}

Ortham / esplugin / 14713678285

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous