swift-protobuf/Sources/SwiftProtobuf/AnyUnpackError.swift

// Sources/SwiftProtobuf/AnyUnpackError.swift - Any Unpacking Errors
//
// Copyright (c) 2014 - 2017 Apple Inc. and the project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See LICENSE.txt for license information:
// https://github.com/apple/swift-protobuf/blob/main/LICENSE.txt
//
// -----------------------------------------------------------------------------
///
/// Errors that can be throw when unpacking a Google_Protobuf_Any.
///
// -----------------------------------------------------------------------------

/// Describes errors that can occur when unpacking an `Google_Protobuf_Any`
/// message.
///
/// `Google_Protobuf_Any` messages can be decoded from protobuf binary, text
/// format, or JSON. The contents are not parsed immediately; the raw data is
/// held in the `Google_Protobuf_Any` message until you `unpack()` it into a
/// message.  At this time, any error can occur that might have occurred from a
/// regular decoding operation.  There are also other errors that can occur due
/// to problems with the `Any` value's structure.
public enum AnyUnpackError: Error {
    /// The `type_url` field in the `Google_Protobuf_Any` message did not match
    /// the message type provided to the `unpack()` method.
    case typeMismatch

    /// Well-known types being decoded from JSON must have only two fields: the
    /// `@type` field and a `value` field containing the specialized JSON coding
    /// of the well-known type.
    case malformedWellKnownTypeJSON

    /// The `Google_Protobuf_Any` message was malformed in some other way not
    /// covered by the other error cases.
    case malformedAnyField
}