Class

PropertyListSerialization

The NSPropertyListSerialization class provides methods that convert Property list to and from several serialized formats. Property list objects include NSData, NSString, NSArray, NSDictionary, NSDate, and NSNumber objects.

Overview

Property list objects are toll-free bridged with their respective Core Foundation types (CFData, CFString, and so on). See Toll-Free Bridging for more information on toll-free bridging.

Nested Types

NSPropertyListFormat

These constants are used to specify a property list serialization format.

NSPropertyListMutabilityOptions

These constants specify mutability options in property lists.

Symbols

Serializing a Property List

class func data(fromPropertyList: Any, format: PropertyListSerialization.PropertyListFormat, options: PropertyListSerialization.WriteOptions)

Returns an NSData object containing a given property list in a specified format.

class func writePropertyList(Any, to: OutputStream, format: PropertyListSerialization.PropertyListFormat, options: PropertyListSerialization.WriteOptions, error: NSErrorPointer)

Writes the specified property list to the specified stream.

Deserializing a Property List

class func propertyList(from: Data, options: PropertyListSerialization.ReadOptions = [], format: UnsafeMutablePointer<PropertyListSerialization.PropertyListFormat>?)

Creates and returns a property list from the specified data.

class func propertyList(with: InputStream, options: PropertyListSerialization.ReadOptions = [], format: UnsafeMutablePointer<PropertyListSerialization.PropertyListFormat>?)

Creates and returns a property list by reading from the specified stream.

Validating a Property List

class func propertyList(Any, isValidFor: PropertyListSerialization.PropertyListFormat)

Returns a Boolean value that indicates whether a given property list is valid for a given format.

Obsolete Methods

class func dataFromPropertyList(Any, format: PropertyListSerialization.PropertyListFormat, errorDescription: UnsafeMutablePointer<NSString?>?)

This method is obsolete and will be deprecated soon.

Deprecated

class func propertyListFromData(Data, mutabilityOption: PropertyListSerialization.MutabilityOptions = [], format: UnsafeMutablePointer<PropertyListSerialization.PropertyListFormat>?, errorDescription: UnsafeMutablePointer<NSString?>?)

This method is deprecated. Use data(fromPropertyList:format:options:) instead.

Deprecated