Skip to main content

SerializeError

Enum SerializeError 

Source
#[non_exhaustive]
pub enum SerializeError { Message { msg: String, }, Format { error: Error, }, IO { error: Error, }, Unexpected { msg: String, }, InvalidOptions(String), SingleQuotedRequiresEscaping { ch: char, }, EmptyResolvedTag, InvalidGlobalTagUri { tag: String, }, CoreTypeTagAsEnumVariant { tag: String, variant: String, }, }
Expand description

Error type used by the YAML serializer.

This type is re-exported as serde_saphyr::SerializeError and serde_saphyr::ser::Error, and is returned by the public serialization APIs (for example serde_saphyr::to_string).

It implements serde::ser::Error, which allows user Serialize impls and Serde derives to report failures via S::Error::custom(...). Such free‑form messages are stored in the Message variant.

Other variants wrap concrete underlying failures that can occur while serializing:

  • Format wraps a std::fmt::Error produced when writing to a fmt::Write target.
  • IO wraps a std::io::Error produced when writing to an io::Write target.
  • SingleQuotedRequiresEscaping reports a SingleQuoted wrapper value that needs YAML escape sequences and therefore cannot be emitted in single-quoted style.
  • EmptyResolvedTag reports a Tagged wrapper whose explicit resolved tag is empty. Use None to represent the absence of a tag.
  • InvalidGlobalTagUri reports a non-local Tagged identity that is not an absolute URI.
  • CoreTypeTagAsEnumVariant reports a YAML core type tag whose name collides with a non-unit enum variant.
  • Unexpected is used internally for invariant violations (e.g., around anchors). It should not normally surface; if it does, please file a bug.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Message

Free-form error.

Fields

§

Format

Wrapper for formatting errors.

Fields

§error: Error
§

IO

Wrapper for I/O errors.

Fields

§error: Error
§

Unexpected

This is used with anchors and should normally not surface, please report bug if it does.

Fields

§

InvalidOptions(String)

Options used would produce invalid YAML (0 indentation, etc)

§

SingleQuotedRequiresEscaping

A crate::SingleQuoted value contains a character that cannot be represented safely in YAML single-quoted style.

Fields

§ch: char
§

EmptyResolvedTag

A crate::Tagged value uses an empty string as an explicit resolved tag identity.

Use None to represent a value without an explicit tag.

§

InvalidGlobalTagUri

A non-local crate::Tagged identity is not a valid absolute URI.

Fields

§

CoreTypeTagAsEnumVariant

A YAML core type tag cannot act as the discriminator for a same-named non-unit enum variant.

Fields

§variant: String

Trait Implementations§

Source§

impl Debug for Error

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl Error for Error

Source§

fn custom<T>(msg: T) -> Error
where T: Display,

Used when a Serialize implementation encounters any error while serializing a type. Read more
Source§

impl From<&String> for Error

Source§

fn from(message: &String) -> Error

Converts to this type from the input type.
Source§

impl From<&str> for Error

Source§

fn from(message: &str) -> Error

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(error: Error) -> Error

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(error: Error) -> Error

Converts to this type from the input type.
Source§

impl From<String> for Error

Source§

fn from(message: String) -> Error

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Forget for Error

§

impl Freeze for Error

§

impl Move for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ServiceExt for T

Source§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
Source§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
Source§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
Source§

impl<T> ToCompactString for T
where T: Display,

Source§

impl<T> ToLine for T
where T: Display,

Source§

fn to_line(&self) -> Line<'_>

Converts the value to a Line.
Source§

impl<T> ToSpan for T
where T: Display,

Source§

fn to_span(&self) -> Span<'_>

Converts the value to a Span.
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToText for T
where T: Display,

Source§

fn to_text(&self) -> Text<'_>

Converts the value to a Text.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more