Enum Error 

#[non_exhaustive]
pub enum Error {
    Message {
        msg: String,
    },
    Format {
        error: Error,
    },
    IO {
        error: Error,
    },
    Unexpected {
        msg: String,
    },
    InvalidOptions(String),
    SingleQuotedRequiresEscaping {
        ch: char,
    },
}

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.
• 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)

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

msg: String

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

msg: String

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

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn custom<T: Display>(msg: T) -> Self

Used when a Serialize implementation encounters any error while serializing a type.

impl Error for Error

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl From<&String> for Error

fn from(message: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Error

fn from(message: &str) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<String> for Error

fn from(message: String) -> Self

Converts to this type from the input type.