[Swift] CustomStringConvertible

Protocol

CustomStringConvertible

사용자 정의화된 텍스트 표현이 있는 타입.

Declaration

protocol CustomStringConvertible

Overview

CustomStringConvertible 프로토콜을 채용하는 타입은 인스턴스를 문자열로 변환할 때 사용되는 고유한 표현을 제공할 수 있다. String(describing:) 이니셜라이저는 모든 타입의 인스턴스를 문자열로 변환하는 데 선호되는 방법이다. 전달된 인스턴스가 CustomStringConvertible을 준수하는 경우, String(describing:) 이니셜라이저 그리고 print(_:) 함수가 인스턴스의 사용자 지정 속성을 사용한다. 타입의 description 속성에 직접적으로 접근하거나 CustomStringConvertible을 일반 제약 조건으로 사용하는 것은 권장하지 않는다. 

Conforming to the CustomStringConvertible Protocol

description 속성을 정의하여 사용자 지정 타입에 CustomStringConvertible을 추가한다.

예를 들면, 이 Point 구조체는 표준 라이브러리에서 제공하는 기본 표현을 사용한다.

struct Point {
    let x: Int, y: Int
}

let p = Point(x: 21, y: 30)
print(p)
// Prints "Point(x: 21, y: 30)"

만약 Point 구조체에 description 속성을 구현하고 CustomStringConvertible을 채용한다면, Point 타입은 고유한 사용자 지정 표현을 제공한다.

extension Point: CustomStringConvertible {
    var description: String {
        return "(\(x), \(y))"
    }
}

print(p)
// Prints "(21, 30)"

예제

enum Shape: Character {
    case spade = "♠"
    case diamond = "◆"
    case heart = "♥"
    case club = "♣"
}

let heart = Shape.heart
print(heart) // heart

위의 코드는 Shape란 열거형을 생성하고, heart를 출력하도록 한 것이다.

enum Shape: Character, CustomStringConvertible {
    case spade = "♠"
    case diamond = "◆"
    case heart = "♥"
    case club = "♣"

    var description: String {
        return String(rawValue)
    }
}

위의 Shape 열거형은 rawValue 타입이 Character이고, CustomStringConvertible 프로토콜을 채용하고 있다.

CustomStringConvertible을 채용하고 있기 때문에 description 속성을 정의할 수 있고, 이를 사용하면 다음과 같다.

let heart = Shape.heart
print(heart) // ♥

 

https://developer.apple.com/documentation/swift/customstringconvertible