Instance Property

description

A textual representation of this instance.

Declaration

var description: String { get }

Discussion

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(describing:) initializer. This initializer works with any type, and uses the custom description property for types that conform to CustomStringConvertible:

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

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

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

The conversion of p to a string in the assignment to s uses the Point type’s description property.

Relationships

See Also

Describing a Character

var debugDescription: String

A textual representation of the character, suitable for debugging.

var customMirror: Mirror

A mirror that reflects the Character instance.

var customPlaygroundQuickLook: _PlaygroundQuickLook

A custom playground Quick Look for the Character instance.

Deprecated
func hash(into: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.