//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

import Foundation

/// Protocol that represents a `Codable` Enum that can be persisted and easily
/// integrate with remote APIs since it must have a raw `String` value.
///
/// That means only enums without associated values can be used as model properties.
///
/// - Example:
///
/// ```swift
/// public enum PostStatus: String, EnumPersistable {
///     case draft
///     case published
/// }
/// ```
/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
///   by host applications. The behavior of this may change without warning.
public protocol EnumPersistable: Codable {

    var rawValue: String { get }

    init?(rawValue: String)

}