struct PredicateCodableConfiguration: CustomDebugStringConvertible, Sendable

<aside> 💡 해당 configuration으로 CodableWithConfiguration 프로토콜 준수성을 추가하면 encoding/decoding 작업시 predicate이 포함할 수 있는 타입 및 keypath를 제한할 수 있다.

<aside> <img src="/icons/list_blue.svg" alt="/icons/list_blue.svg" width="40px" /> 목차

</aside>

다음과 같이 작성해볼 수 있다:

var configuration = PredicateCodableConfiguration.standardConfiguration
configuration.allowType(Message.self, identifier: "MyApp.Message")
configuration.allowType(Person.self, identifier: "MyApp.Person")
configuration.allowKeyPath(\\Message.sender, identifier: "MyApp.Message.sender")
configuration.allowKeyPath(\\Person.firstName, identifier: "MyApp.Person.firstName")
configuration.allowKeyPath(\\Person.lastName, identifier: "MyApp.Person.lastName")

struct MyRequest: Codable {
    let predicate: Predicate<Message>
    
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(predicate, forKey: .predicate, configuration: **configuration**)
    }
    
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        predicate = try container.decode(Predicate<Message>.self, forKey: .predicate, configuration: **configuration**)
    }
}

위 예제에서 predicate 프로퍼티가 configuration에서 허용하지 않은 타입 또는 keypath를 포함할 경우, encoding/decoding 작업시 에러를 던진다.

API

생성

타입 및 keypath의 허용/비허용 설정

모아보기

init()
static let standardConfiguration: PredicateCodableConfiguration

mutating func allowType(_ type: Any.Type, identifier: String? = nil)
mutating func disallowType(_ type: Any.Type)

mutating func allowPartialType(_ type: Any.Type, identifier: String)
mutating func disallowPartialType(_ type: Any.Type)

mutating func allowKeyPath(_ keyPath: AnyKeyPath, identifier: String)
mutating func disallowKeyPath(_ keyPath: AnyKeyPath)

mutating func allowKeyPathsForPropertiesProvided<T>(by type: T.Type, recursive: Bool = false) where T: PredicateCodableKeyPathProviding
mutating func disallowKeyPathsForPropertiesProvided<T>(by type: T.Type, recursive: Bool = false) where T: PredicateCodableKeyPathProviding

mutating func allow(_ other: PredicateCodableConfiguration)

// conforming CustomDebugStringConvertible protocol
var debugDescription: String

API

생성

타입 및 keypath의 허용/비허용 설정

모아보기

참고자료