Enum vasp_poscar::ValidationError
[−]
[src]
pub enum ValidationError { NewlineInComment, InvalidSymbol(Option<String>), NoAtoms, BadScaleLine, InconsistentNumGroups, WrongLength(&'static str, usize), // some variants omitted }
Covers all the reasons why RawPoscar::validate
might get mad at you.
Beyond checking obvious problems like mismatched lengths, these
limitations also exist to ensure that a Poscar
can be roundtripped
through its file representation.
The variants are public so that by looking at the docs you can see all the possible errors. That said, you have no good reason to write code that matches on this.
...right?
Variants
NewlineInComment
The comment line is more than one line.
InvalidSymbol(Option<String>)
A requirement on group_symbols
was violated.
There are a few more restrictions in addition to the no-leading-digit restriction mentioned in format.md, in order to ensure roundtripping:
- A symbol may not be the empty string
- A symbol may not contain whitespace
NoAtoms
Poscar is required to have at least one atom.
BadScaleLine
The inner value in the scale line must be positive.
InconsistentNumGroups
Mismatch between group_counts
and group_symbols
lengths.
WrongLength(&'static str, usize)
Length of a member is incorrect.
Trait Implementations
impl Debug for ValidationError
[src]
impl Fail for ValidationError
[src]
fn cause(&self) -> Option<&Fail>
[src]
Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. Read more
fn backtrace(&self) -> Option<&Backtrace>
[src]
Returns a reference to the Backtrace
carried by this failure, if it carries one. Read more
fn context<D>(self, context: D) -> Context<D> where
D: Display + Send + Sync + 'static,
[src]
D: Display + Send + Sync + 'static,
Provides context for this failure. Read more
fn compat(self) -> Compat<Self>
[src]
Wraps this failure in a compatibility wrapper that implements std::error::Error
. Read more
fn causes(&self) -> Causes
[src]
Returns a iterator over the causes of this Fail
with itself as the first item and the root_cause
as the final item. Read more
fn root_cause(&self) -> &(Fail + 'static)
[src]
Returns the "root cause" of this Fail
- the last value in the cause chain which does not return an underlying cause
. Read more