structUnsafeMutablePointer<T>
Initializers
Construct a null pointer.
Declaration
init()
Convert from an opaque C pointer to a typed pointer
This is a fundamentally unsafe conversion.
Declaration
init(_other:COpaquePointer)
Convert from an UnsafeMutablePointer of a different type.
This is a fundamentally unsafe conversion.
Declaration
init<U>(_from:UnsafeMutablePointer<U>)
Convert from a UnsafePointer of a different type.
This is a fundamentally unsafe conversion.
Declaration
init<U>(_from:UnsafePointer<U>)
Construct an UnsafeMutablePointer from a given address in memory.
This is a fundamentally unsafe conversion.
Declaration
init(bitPattern:UWord)
Construct an UnsafeMutablePointer from a given address in memory.
This is a fundamentally unsafe conversion.
Declaration
init(bitPattern:Word)
Create an instance initialized with nil.
Declaration
init(nilLiteral: ())
Instance Variables
A textual representation of self, suitable for debugging.
Declaration
vardebugDescription:String{get}
The hash value.
Axiom: x == y implies x.hashValue == y.hashValue
Note: the hash value is not guaranteed to be stable across different invocations of the same program. Do not persist the hash value across program runs.
Declaration
varhashValue:Int{get}
Access the underlying raw memory, getting and setting values.
Declaration
varmemory:T{getset}
Subscripts
Declaration
subscript(i:Int) ->T{getnonmutatingset}
Static Methods
Allocate memory for num objects of type T.
Postcondition: the memory is allocated, but not initialized.
Declaration
staticfuncalloc(num:Int) ->UnsafeMutablePointer<T>
Instance Methods
Return self offset by n steps.
Returns: If n > 0, the result of applying successor to
self n times. If n < 0, the result of applying
predecessor to self -n times. Otherwise, self.
Complexity: O(1)
Declaration
funcadvancedBy(n:Int) ->UnsafeMutablePointer<T>
Assign from count values beginning at source into
initialized memory, proceeding from the last value to the first.
Use this for assigning ranges into later memory that may overlap
with the source range.
Requires: either source precedes self or follows self + count.
Declaration
funcassignBackwardFrom(source:UnsafeMutablePointer<T>,count:Int)
Assign from count values beginning at source into initialized
memory, proceeding from the first element to the last.
Declaration
funcassignFrom(source:UnsafeMutablePointer<T>,count:Int)
Deallocate num objects.
num number of objects to deallocate. Should match exactly
the value that was passed to alloc() (partial deallocations are not
possible).
Precondition: the memory is not initialized.
Postcondition: the memory has been deallocated.
Declaration
funcdealloc(num:Int)
Destroy the object the pointer points to.
Precondition: the memory is initialized.
Postcondition: the value has been destroyed and the memory must be initialized before being used again.
Declaration
funcdestroy()
Destroy the count objects the pointer points to.
Precondition: the memory is initialized.
Postcondition: the value has been destroyed and the memory must be initialized before being used again.
Declaration
funcdestroy(count:Int)
Return the minimum number of applications of successor or
predecessor required to reach other from self.
Complexity: O(1).
Declaration
funcdistanceTo(x:UnsafeMutablePointer<T>) ->Int
Transform self into a series of machine words that can be
appropriately interpreted by C varargs
Declaration
funcencode() ->[Word]
Initialize the value the pointer points to, to construct an object where there was no object previously stored.
Precondition: the memory is not initialized.
Postcondition: the memory is initalized; the value should eventually be destroyed or moved from to avoid leaks.
Declaration
funcinitialize(newvalue:T)
Copy the elements of C into raw memory.
Precondition: the memory is not initialized.
Declaration
funcinitializeFrom<C:CollectionTypewhereT==T>(source:C)
Copy count values beginning at source into raw memory.
Precondition: the memory is not initialized.
Requires: self and source may not overlap.
Declaration
funcinitializeFrom(source:UnsafeMutablePointer<T>,count:Int)
Retrieve the value the pointer points to, moving it away from the location referenced in memory.
Equivalent to reading memory property and calling destroy(),
but more efficient.
Precondition: the memory is initialized.
Postcondition: the value has been destroyed and the memory must be initialized before being used again.
Declaration
funcmove() ->T
Assign from count values beginning at source into initialized
memory, transforming the source values into raw memory.
Requires: the self and source ranges may not overlap.
Declaration
funcmoveAssignFrom(source:UnsafeMutablePointer<T>,count:Int)
Move count values beginning at source into uninitialized memory,
transforming the source values into raw memory, proceeding from
the last value to the first. Use this for copying ranges into
later memory that may overlap with the source range.
Requires: either source precedes self or follows self + count.
Declaration
funcmoveInitializeBackwardFrom(source:UnsafeMutablePointer<T>,count:Int)
Move count values beginning at source into raw memory, transforming the source values into raw memory.
Declaration
funcmoveInitializeFrom(source:UnsafeMutablePointer<T>,count:Int)
Returns the previous consecutive value before self.
Requires: the previous value is representable.
Declaration
funcpredecessor() ->UnsafeMutablePointer<T>
Declaration
mutatingfuncput(x:T)
Returns the next consecutive value after self.
Requires: the next value is representable.
Declaration
funcsuccessor() ->UnsafeMutablePointer<T>
A pointer to an object of type
T. This type provides no automated memory management, and therefore the user must take care to allocate and free memory appropriately.The pointer can be in one of the following states:
memory is not allocated (for example, pointer is null, or memory has been deallocated previously);
memory is allocated, but value has not been initialized;
memory is allocated and value is initialized.