struct AutoreleasingUnsafeMutablePointer<Memory>

A mutable pointer-to-ObjC-pointer argument.

This type has implicit conversions to allow passing any of the following to a C or ObjC API:

  • nil, which gets passed as a null pointer,
  • an inout argument of the referenced type, which gets passed as a pointer to a writeback temporary with autoreleasing ownership semantics,
  • an UnsafeMutablePointer<Memory>, which is passed as-is.

Passing pointers to mutable arrays of ObjC class pointers is not directly supported. Unlike UnsafeMutablePointer<Memory>, AutoreleasingUnsafeMutablePointer<Memory> must reference storage that does not own a reference count to the referenced value. UnsafeMutablePointer's operations, by contrast, assume that the referenced storage owns values loaded from or stored to it.

This type does not carry an owner pointer unlike the other C*Pointer types because it only needs to reference the results of inout conversions, which already have writeback-scoped lifetime.

Inheritance CVarArgType, CustomDebugStringConvertible, Equatable, NilLiteralConvertible, _PointerType View Protocol Hierarchy →
Import import Swift



Initialize to a null pointer.

Deprecated: init() will be removed in Swift 3. Use nil instead.



Explicit construction from an UnsafeMutablePointer.

This is inherently unsafe; UnsafeMutablePointer assumes the referenced memory has +1 strong ownership semantics, whereas AutoreleasingUnsafeMutablePointer implies +0 semantics.


init<U>(_ ptr: UnsafeMutablePointer<U>)

Create an instance initialized with nil.


init(nilLiteral: ())

Instance Variables

var debugDescription: String

A textual representation of self, suitable for debugging.


var debugDescription: String { get }
var memory: Memory

Access the underlying raw memory, getting and setting values.


var memory: Memory { get set }


subscript(_: Int)

Access the ith element of the raw array pointed to by self.

Requires: self != nil.


subscript(i: Int) -> Memory { get }