Enum subplot::SubplotError
source · [−]pub enum SubplotError {
Show 44 variants
Warnings(usize),
BindingsFileNotFound(PathBuf, Error),
FunctionsFileNotFound(PathBuf, Error),
UnknownSimplePatternKind(String),
SimplePatternKindMismatch(String),
StrayBraceInSimplePattern(String),
SimplePatternHasMetaCharacters(String),
BindingFileParseError(PathBuf, Box<SubplotError>),
BindingUnknown(String),
BindingNotUnique(String, MatchedSteps),
BindingWithoutKnownKeyword(String),
BindingHasManyKeywords(String),
UnknownTypeInBinding(String),
ChildNoStdin,
ChildFailed(String),
NoFunction(String),
NoTitle,
MissingTemplate,
AmbiguousTemplate,
TemplateSupportNotPresent,
NotJson,
ScenarioBeforeHeading,
NoStepKeyword(String),
UnknownStepKind(String),
ContinuationTooEarly,
DuplicateEmbeddedFilename(String),
RepeatedAddNewlineAttribute(String),
UnrecognisedAddNewline(String, String),
BasedirError(PathBuf),
OutputDirectoryNotFound(String),
NoTemplateSpecDirectory(PathBuf),
TemplateError(String, Error),
UnknownClasses(String),
TemplateNoRun,
EmbeddedFileNotFound(String),
PikchrRenderError(String),
NoScenariosMatched(String),
IoError {
source: Error,
},
PandocError {
source: PandocError,
},
RegexError {
source: Error,
},
JsonError {
source: Error,
},
YamlError {
source: Error,
},
Ast(Error),
Utf8Error(Utf8Error),
}
Expand description
Define all the kinds of errors any part of this crate can return.
Variants
Warnings(usize)
Document has non-fatal errors.
BindingsFileNotFound(PathBuf, Error)
Subplot could not find a file named as a bindings file.
FunctionsFileNotFound(PathBuf, Error)
Subplot could not find a file named as a functions file.
UnknownSimplePatternKind(String)
The simple pattern specifies a kind that is unknown.
SimplePatternKindMismatch(String)
The simple pattern and the type map disagree over the kind of a match
StrayBraceInSimplePattern(String)
The simple pattern contains a stray { or }.
SimplePatternHasMetaCharacters(String)
The simple pattern has regex metacharacters.
Simple patterns are not permitted to have regex metacharacters in them
unless the pattern is explicitly marked regex: false
to indicate that
the binding author understands what they’re up to.
BindingFileParseError(PathBuf, Box<SubplotError>)
Error while parsing a bindings file
BindingUnknown(String)
Scenario step does not match a known binding
This may be due to the binding missing entirely, or that the step or the binding has a typo, or that a pattern in the binding doesn’t match what the author thinks it matches.
BindingNotUnique(String, MatchedSteps)
Scenario step matches more than one binding
THis may be due to bindings being too general, or having unusual overlaps in their matching
BindingWithoutKnownKeyword(String)
A binding in the bindings file doesn’t specify a known keyword.
BindingHasManyKeywords(String)
A binding has more than one keyword (given/when/then).
UnknownTypeInBinding(String)
A binding lists an unknown type in its type map
ChildNoStdin
Subplot tried to use a program, but couldn’t feed it data
Subplot uses some helper programs to implement some of its functionality, for example the GraphViz dot program. This error means that when tried to start a helper program and write to the helper’s standard input stream, it failed to get the stream.
This probably implies there’s something wrong on your system.
ChildFailed(String)
Subplot helper program failed
Subplot uses some helper programs to implement some of its functionality, for example the GraphViz dot program. This error means that the helper program failed (exit code was not zero).
This probably implies there’s something wrong in Subplot. Please report this error to the Subplot project.
NoFunction(String)
Binding doesn’t define a function
All binding must define the name of the function that
implements the step. The bindings file has at least one
binding that doesn’t define one. To fix, add a function:
field to the binding.
NoTitle
Document has no title
The document YAML metadata does not define a document title.
To fix, add a title
field.
MissingTemplate
Document has no template
The document YAML metadata does not define the template to use during code generation.
To fix, ensure an appropriate impl
entry is present.
AmbiguousTemplate
Document has more than one template
The document YAML metadata specifies more than one possible template implementation to be used during code generation.
To fix, specify --template
on the codegen CLI.
TemplateSupportNotPresent
Document does not support the requested template
The document YAML metadata does not specify support for the stated template.
To fix, specify a template which is provided for in the document.
NotJson
Pandoc AST is not JSON
Subplot acts as a Pandoc filter, and as part of that Pandoc constructs an abstract syntax tree from the input document, and feeds it to the filter as JSON. However, when Subplot was parsing the AST, it wasn’t JSON.
This probably means there’s something wrong with Pandoc, it’s Rust bindings, or Subplot.
ScenarioBeforeHeading
First scenario is before first heading
Subplot scenarios are group by the input document’s structure. Each scenario must be in a chapter, section, subsection, or other structural element with a heading. Subplot found a scenario block before the first heading in the document.
To fix, add a heading or move the scenario after a heading.
NoStepKeyword(String)
Step does not have a keyword.
UnknownStepKind(String)
Unknown scenario step keyword.
Each scenario step must start with a known keyword (given, when, then, and, but), but Subplot didn’t find one it recognized.
This is usually due to a typing mistake or similar.
ContinuationTooEarly
Scenario step uses continuation keyword too early
If a continuation keyword (and
or but
) is used too early
in a scenario (i.e. before any other keyword was used) then
it cannot be resolved to whichever keyword it should have been.
DuplicateEmbeddedFilename(String)
Embedded file has the same name as another embedded file
Names of embedded files must be unique in the input document, but Subplot found at least one with the same name as another.
RepeatedAddNewlineAttribute(String)
Embedded file has more than one add-newline
attribute
The add-newline
attribute can only be specified once for any given
embedded file
UnrecognisedAddNewline(String, String)
Unrecognised add-newline
attribute value on an embedded file
The add-newline
attribute can only take the values auto
, yes
,
and no
.
BasedirError(PathBuf)
Couldn’t determine base directory from input file name.
Subplot needs to to determine the base directory for files referred to by the markdown input file (e.g., bindings and functions files). It failed to do that from the name of the input file. Something weird is happening.
OutputDirectoryNotFound(String)
Output goes into a directory that does not exist.
Subplot needs to know in which directory it should write its output file, since it writes a temporary file first, then renames it to the final output file. The temporary file is created in the same directory as the final output file. However, Subplot could not find that directory.
NoTemplateSpecDirectory(PathBuf)
The template.yaml is not in a directory.
Template specifications reference files relative to the template.yaml file, but Subplot could not find the name of the directory containing the template.yaml file. Something is very weird.
TemplateError(String, Error)
A code template has an error.
UnknownClasses(String)
Unknown classes in use in document
TemplateNoRun
Template does not specify how to run generated program
The template.yaml file used does not specify how to run the generated program, but user asked codegen to run it.
EmbeddedFileNotFound(String)
An embedded file was not found.
PikchrRenderError(String)
When rendering a pikchr, something went wrong.
NoScenariosMatched(String)
When attempting to codegen, no scenarios matched the desired template language
IoError
Fields
source: Error
The wrapped error.
I/O error
Subplot did some I/O, and it failed. This is a generic wrapper for any kind of I/O error.
PandocError
Fields
source: PandocError
The wrapped error.
Pandoc error
Subplot got an error from Panoc. This is a generic wrapper for any kinds of Pandoc errors.
RegexError
Fields
source: Error
The wrapped error.
Regular expression error
Subplot uses regular expressions. This is a generic wrapper for any kinds of errors related to that.
JsonError
Fields
source: Error
The wrapped error.
JSON error
Subplot parses and generates JSON. This is a generic wrapper for any kinds of errors related to that.
YamlError
Fields
source: Error
The wrapped error.
YAML error
Subplot parses YAML. This is a generic wrapper for any kinds of errors related to that.
Ast(Error)
Abstract syntax tree error.
Utf8Error(Utf8Error)
UTF8 conversion error.
Implementations
sourceimpl SubplotError
impl SubplotError
sourcepub fn child_failed(msg: &str, output: &Output) -> SubplotError
pub fn child_failed(msg: &str, output: &Output) -> SubplotError
Construct a ChildFailed error.
Trait Implementations
sourceimpl Debug for SubplotError
impl Debug for SubplotError
sourceimpl Display for SubplotError
impl Display for SubplotError
sourceimpl Error for SubplotError
impl Error for SubplotError
sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
sourcefn backtrace(&self) -> Option<&Backtrace>
fn backtrace(&self) -> Option<&Backtrace>
backtrace
)Returns a stack backtrace, if available, of where this error occurred. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
sourceimpl From<Error> for SubplotError
impl From<Error> for SubplotError
sourceimpl From<Error> for SubplotError
impl From<Error> for SubplotError
sourceimpl From<Error> for SubplotError
impl From<Error> for SubplotError
sourceimpl From<Error> for SubplotError
impl From<Error> for SubplotError
sourceimpl From<PandocError> for SubplotError
impl From<PandocError> for SubplotError
sourcefn from(source: PandocError) -> Self
fn from(source: PandocError) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for SubplotError
impl Send for SubplotError
impl Sync for SubplotError
impl Unpin for SubplotError
impl !UnwindSafe for SubplotError
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more