#[non_exhaustive]pub enum DeserializeError {
Show 67 variants
Message {
msg: String,
location: Location,
},
InvalidOptions {
msg: String,
location: Location,
},
ExternalMessage {
source: Box<ExternalMessageSource>,
msg: String,
code: Option<String>,
params: Vec<(String, String)>,
location: Location,
},
Eof {
location: Location,
},
MultipleDocuments {
hint: &'static str,
location: Location,
},
Unexpected {
expected: &'static str,
location: Location,
},
MergeValueNotMapOrSeqOfMaps {
location: Location,
},
MergeKeyNotAllowed {
location: Location,
},
InvalidBinaryBase64 {
location: Location,
},
BinaryNotUtf8 {
location: Location,
},
TaggedScalarCannotDeserializeIntoString {
location: Location,
},
UnexpectedSequenceEnd {
location: Location,
},
UnexpectedMappingEnd {
location: Location,
},
InvalidBooleanStrict {
location: Location,
},
InvalidCharNull {
location: Location,
},
InvalidCharNotSingleScalar {
location: Location,
},
NullIntoString {
location: Location,
},
BytesNotSupportedMissingBinaryTag {
location: Location,
},
UnexpectedValueForUnit {
location: Location,
},
ExpectedEmptyMappingForUnitStruct {
location: Location,
},
UnexpectedContainerEndWhileSkippingNode {
location: Location,
},
InternalSeedReusedForMapKey {
location: Location,
},
ValueRequestedBeforeKey {
location: Location,
},
ExpectedStringKeyForExternallyTaggedEnum {
location: Location,
},
ExternallyTaggedEnumExpectedScalarOrMapping {
location: Location,
},
UnexpectedValueForUnitEnumVariant {
location: Location,
},
InvalidUtf8Input,
AliasReplayCounterOverflow {
location: Location,
},
AliasReplayLimitExceeded {
total_replayed_events: usize,
max_total_replayed_events: usize,
location: Location,
},
AliasExpansionLimitExceeded {
anchor_id: usize,
expansions: usize,
max_expansions_per_anchor: usize,
location: Location,
},
AliasReplayStackDepthExceeded {
depth: usize,
max_depth: usize,
location: Location,
},
FoldedBlockScalarMustIndentContent {
location: Location,
},
InternalDepthUnderflow {
location: Location,
},
InternalRecursionStackEmpty {
location: Location,
},
RecursiveReferencesRequireWeakTypes {
location: Location,
},
InvalidScalar {
ty: &'static str,
location: Location,
},
NonFiniteFloat {
value: String,
location: Location,
},
SerdeInvalidType {
unexpected: String,
expected: String,
location: Location,
},
SerdeInvalidValue {
unexpected: String,
expected: String,
location: Location,
},
SerdeInvalidLength {
len: usize,
expected: String,
location: Location,
},
SerdeUnknownVariant {
variant: String,
expected: Vec<&'static str>,
location: Location,
},
SerdeUnknownField {
field: String,
expected: Vec<&'static str>,
location: Location,
},
SerdeMissingField {
field: &'static str,
location: Location,
},
UnexpectedContainerEndWhileReadingKeyNode {
location: Location,
},
DuplicateMappingKey {
key: Option<String>,
location: Location,
},
TaggedEnumMismatch {
tagged: String,
target: &'static str,
location: Location,
},
SerdeVariantId {
msg: String,
location: Location,
},
ExpectedMappingEndAfterEnumVariantValue {
location: Location,
},
ContainerEndMismatch {
location: Location,
},
UnknownAnchor {
location: Location,
},
CyclicInclude {
id: String,
stack: Vec<String>,
location: Location,
},
UnsupportedIncludeForm {
location: Location,
},
ResolverError {
target: String,
error: IncludeResolveError,
stack: Vec<String>,
location: Location,
},
AliasError {
msg: String,
error: Box<Error>,
locations: Locations,
},
HookError {
msg: String,
location: Location,
},
UnresolvedProperty {
name: String,
location: Location,
},
InvalidPropertyName {
name: String,
location: Location,
},
PropertyRequiredButUnset {
name: String,
message: String,
location: Location,
},
PropertyRequiredButEmpty {
name: String,
message: String,
location: Location,
},
Budget {
breach: BudgetBreach,
location: Location,
},
IOError {
cause: Error,
},
QuotingRequired {
value: String,
location: Location,
},
CannotBorrowTransformedString {
reason: TransformReason,
location: Location,
},
IndentationError {
required: RequireIndent,
actual: usize,
location: Location,
},
WithSnippet {
regions: Vec<CroppedRegion>,
crop_radius: usize,
error: Box<Error>,
},
UnsupportedTag {
tag: String,
location: Location,
},
TaggedStructFieldName {
tag: String,
location: Location,
},
}Expand description
Error type compatible with serde::de::Error.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Message
Free-form error with optional source location.
InvalidOptions
Invalid deserializer options were provided.
ExternalMessage
Text primarily produced by a dependency (parser / validators).
Renderers should call Localizer::override_external_message to allow callers
to replace or translate this text.
Fields
source: Box<ExternalMessageSource>Dependency that produced the message and any structured source error.
This is boxed to keep Error below Clippy’s large-error threshold.
Eof
Unexpected end of input.
MultipleDocuments
More than one YAML document was found when a single document was expected.
This is typically returned by single-document entrypoints like from_str* / from_slice*
/ read_to_end* when the input stream contains multiple ----delimited documents.
Unexpected
Structural/type mismatch — something else than the expected token/value was seen.
MergeValueNotMapOrSeqOfMaps
YAML merge (<<) value was not a mapping or a sequence of mappings.
MergeKeyNotAllowed
YAML merge keys (<<) are disabled by policy.
InvalidBinaryBase64
!!binary scalar could not be decoded as base64.
BinaryNotUtf8
!!binary scalar decoded successfully but was not valid UTF-8 when a string was expected.
TaggedScalarCannotDeserializeIntoString
A scalar was explicitly tagged but could not be deserialized into a string.
UnexpectedSequenceEnd
Encountered a sequence end where it was not expected.
UnexpectedMappingEnd
Encountered a mapping end where it was not expected.
InvalidBooleanStrict
Invalid boolean literal in strict mode.
InvalidCharNull
Invalid char: null cannot be deserialized into char.
InvalidCharNotSingleScalar
Invalid char: expected a single Unicode scalar value.
NullIntoString
Cannot deserialize null into string.
BytesNotSupportedMissingBinaryTag
Bytes (&[u8] / Vec<u8>) are not supported unless the scalar is tagged as !!binary.
UnexpectedValueForUnit
Unexpected value for unit (()).
ExpectedEmptyMappingForUnitStruct
Unit struct expected an empty mapping.
UnexpectedContainerEndWhileSkippingNode
While skipping a node, a container end event was encountered unexpectedly.
InternalSeedReusedForMapKey
Internal error: a seed was reused for a map key.
ValueRequestedBeforeKey
Internal error: value requested before key.
ExpectedStringKeyForExternallyTaggedEnum
Externally tagged enum: expected a string key.
ExternallyTaggedEnumExpectedScalarOrMapping
Externally tagged enum: expected either a scalar or a mapping.
UnexpectedValueForUnitEnumVariant
Unexpected value for unit enum variant.
InvalidUtf8Input
Input was not valid UTF-8.
AliasReplayCounterOverflow
Alias replay counter overflow.
AliasReplayLimitExceeded
Alias replay total event limit exceeded.
AliasExpansionLimitExceeded
Alias expansion limit exceeded for a single anchor.
AliasReplayStackDepthExceeded
Alias replay stack depth limit exceeded.
FoldedBlockScalarMustIndentContent
Folded block scalars must indent their content.
InternalDepthUnderflow
Internal: depth counter underflow.
InternalRecursionStackEmpty
Internal: recursion stack empty.
RecursiveReferencesRequireWeakTypes
recursive references require weak recursion types.
InvalidScalar
Scalar parsing failed for the requested target type.
NonFiniteFloat
In a typeless position (e.g. deserialize_any targeting serde_json::Value), a
scalar resolved to a non-finite float — NaN, ±Inf, or a decimal literal that
overflows f64 to infinity (e.g. 1e999) — and
the effective NonFiniteFloatPolicy is Reject,
rejecting it before passing it to the visitor.
Fields
SerdeInvalidType
Serde-generated: invalid type.
SerdeInvalidValue
Serde-generated: invalid value.
SerdeInvalidLength
Serde-generated: invalid sequence or container length.
Fields
SerdeUnknownVariant
Serde-generated: unknown enum variant.
SerdeUnknownField
Serde-generated: unknown field.
SerdeMissingField
Serde-generated: missing required field.
UnexpectedContainerEndWhileReadingKeyNode
Encountered the end of a sequence or mapping while reading a key node.
This indicates a structural mismatch in the input.
DuplicateMappingKey
Duplicate key in a mapping.
When the duplicate key can be rendered as a string-like scalar, key is provided.
TaggedEnumMismatch
Tagged enum name does not match the target enum.
SerdeVariantId
Serde-generated error while deserializing an enum variant identifier.
ExpectedMappingEndAfterEnumVariantValue
Expected the end of a mapping after an externally tagged enum variant value.
ContainerEndMismatch
UnknownAnchor
Alias references a non-existent anchor.
CyclicInclude
Cyclic include detected.
UnsupportedIncludeForm
!include currently only supports the scalar form: !include <path>
ResolverError
Failed to resolve include
AliasError
Error related to an alias, with both reference (use-site) and defined (anchor) locations.
error keeps the original error, so it renders with the active MessageFormatter and
Localizer, and std::error::Error::source returns it.
Fields
HookError
Error when parsing robotic and other extensions beyond standard YAML. (error in extension hook).
UnresolvedProperty
A ${NAME} property reference could not be resolved from the configured property map.
InvalidPropertyName
A ${...} property candidate used an invalid property name.
Fields
PropertyRequiredButUnset
A ${NAME?text} or ${NAME:?text} reference required a value but the property was unset.
message may be empty. Hints containing non-empty property-map values preserve their
original source text instead of exposing the resolved values.
PropertyRequiredButEmpty
A ${NAME:?text} reference required a non-empty value but the property was present and empty.
message may be empty. Hints containing non-empty property-map values preserve their
original source text instead of exposing the resolved values.
Budget
A YAML budget limit was exceeded.
IOError
Unexpected I/O error. This may happen only when deserializing from a reader.
The default display is IO error; std::error::Error::source provides
the underlying cause so error chains do not repeat its message.
QuotingRequired
The value is targeted to the string field but can be interpreted as a number or boolean.
This error can only happen if no_schema set true.
CannotBorrowTransformedString
The target type requires a borrowed string (&str), but the value was transformed
during parsing (e.g., through escape processing, line folding, or multi-line normalization)
and cannot be borrowed from the input.
Use String or Cow<str> instead of &str to handle transformed values.
Fields
reason: TransformReasonThe reason why the string had to be transformed and cannot be borrowed.
IndentationError
Indentation does not meet the configured RequireIndent requirement.
Fields
required: RequireIndentThe indentation requirement that was violated.
WithSnippet
Wrap an error with the full input text, enabling rustc-like snippet rendering.
Fields
regions: Vec<CroppedRegion>Cropped source windows used for snippet rendering.
This intentionally does NOT store the full input text, to avoid retaining large YAML inputs inside errors.
UnsupportedTag
An explicitly specified YAML tag is not supported by this crate.
TaggedStructFieldName
A struct field name’s explicit tag violates the enabled
crate::Options::reject_tagged_field_names policy.
Implementations§
Source§impl Error
impl Error
Sourcepub fn without_snippet(&self) -> &Self
pub fn without_snippet(&self) -> &Self
Provide “no snippet” version for cases when snippet rendering is not desired.
Sourcepub fn render(&self) -> String
pub fn render(&self) -> String
Render this error using the built-in developer formatter.
This is the deferred-rendering entrypoint. It is equivalent to Display/to_string()
output, but also allows callers to choose a custom MessageFormatter via
Error::render_with_options.
Sourcepub fn render_with_formatter(&self, formatter: &dyn MessageFormatter) -> String
pub fn render_with_formatter(&self, formatter: &dyn MessageFormatter) -> String
Render this error using a custom message formatter.
Sourcepub fn render_with_options(&self, options: RenderOptions<'_>) -> String
pub fn render_with_options(&self, options: RenderOptions<'_>) -> String
Render this error using the provided options.
To append to an existing writer, use Error::render_to.
Sourcepub fn render_to<W: Write + ?Sized>(
&self,
writer: &mut W,
options: RenderOptions<'_>,
) -> Result
pub fn render_to<W: Write + ?Sized>( &self, writer: &mut W, options: RenderOptions<'_>, ) -> Result
Append this error to writer using the provided rendering options.
Produces the same text as Error::render_with_options without first
collecting the complete output in an intermediate String. Message
formatters and snippet rendering still perform their own allocations.
Returns fmt::Result, propagating any error from writer. On failure,
the writer may already contain part of the rendered error.
let err = serde_saphyr::from_str::<u16>("eighty").unwrap_err();
let mut output = String::from("invalid configuration: ");
err.render_to(&mut output, serde_saphyr::render_options! {
source_name: Some("config.yaml"),
})?;
assert!(output.starts_with("invalid configuration: "));
assert!(output.contains("config.yaml:1:1"));Sourcepub fn cannot_borrow_transformed(reason: TransformReason) -> Self
pub fn cannot_borrow_transformed(reason: TransformReason) -> Self
Construct a CannotBorrowTransformedString error for the given reason.
This error is returned when deserializing to &str but the string value
was transformed during parsing and cannot be borrowed from the input.
Sourcepub fn location(&self) -> Option<Location>
pub fn location(&self) -> Option<Location>
If the error has a known location, return it.
Returns:
Some(Location)when coordinates are known;Noneotherwise.
Used by:
- Callers that want to surface precise positions to users.
Sourcepub fn locations(&self) -> Option<Locations>
pub fn locations(&self) -> Option<Locations>
Return a pair of locations associated with this error.
-
For syntax and other errors that carry a single
Location, this returns two identical locations. -
For validation errors (when the
garde/validatorfeature is enabled), this returns the(reference_location, defined_location)pair for the first validation entry.These two locations may differ when YAML anchors/aliases are involved.
-
Returns
Nonewhen no meaningful location information is available.
Trait Implementations§
Source§impl Error for Error
impl Error for Error
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
Snippet wrappers forward the wrapped error’s cause to avoid duplicate messages.
Use Error::without_snippet to inspect the wrapped error itself.
As an exception, Error::AliasError and its snippet wrappers return the
wrapped error directly to preserve the existing source chain.
I/O errors return their underlying std::io::Error.
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
Source§impl Error for Error
impl Error for Error
Source§fn custom<T: Display>(msg: T) -> Self
fn custom<T: Display>(msg: T) -> Self
Source§fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self
fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self
Deserialize receives a type different from what it was
expecting. Read moreSource§fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self
fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self
Deserialize receives a value of the right type but that
is wrong for some other reason. Read moreSource§fn invalid_length(len: usize, exp: &dyn Expected) -> Self
fn invalid_length(len: usize, exp: &dyn Expected) -> Self
Source§fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self
fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self
Deserialize enum type received a variant with an
unrecognized name.Source§fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self
fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self
Deserialize struct type received a field with an
unrecognized name.Source§fn missing_field(field: &'static str) -> Self
fn missing_field(field: &'static str) -> Self
Deserialize struct type expected to receive a required
field with a particular name but that field was not present in the
input.Source§fn duplicate_field(field: &'static str) -> Self
fn duplicate_field(field: &'static str) -> Self
Deserialize struct type received more than one of the
same field.