Instance Method

description(withLocale:indent:)

Returns a string object that represents the contents of the dictionary, formatted as a property list.

Declaration

func description(withLocale locale: Any?, indent level: Int) -> String

Parameters

locale

An object that specifies options used for formatting each of the dictionary’s keys and values; pass nil if you don’t want them formatted.

On iOS and macOS 10.5 and later, either an instance of NSDictionary or an NSLocale object may be used for locale. In OS X v10.4 and earlier it must be an instance of NSDictionary.

level

Specifies a level of indentation, to make the output more readable: the indentation is (4 spaces) * level.

Return Value

A string object that represents the contents of the dictionary, formatted as a property list.

Discussion

The returned NSString object contains the string representations of each of the dictionary’s entries. description(withLocale:indent:) obtains the string representation of a given key or value as follows:

  • If the object is an NSString object, it is used as is.

  • If the object responds to descriptionWithLocale:indent:, that method is invoked to obtain the object’s string representation.

  • If the object responds to descriptionWithLocale:, that method is invoked to obtain the object’s string representation.

  • If none of the above conditions is met, the object’s string representation is obtained by through its description property.

If each key in the dictionary responds to compare:, the entries are listed in ascending order, by key. Otherwise, the order in which the entries are listed is undefined.

See Also

Describing a Dictionary

var description: String

A string that represents the contents of the dictionary, formatted as a property list.

var descriptionInStringsFileFormat: String

A string that represents the contents of the dictionary, formatted in .strings file format.

func description(withLocale: Any?) -> String

Returns a string object that represents the contents of the dictionary, formatted as a property list.

var customMirror: Mirror

A mirror that reflects the dictionary.