Memory Structure Reference


                    
                    
                    init()

An empty instance.

Declaration

Swift

public init()

Show on GitHub


                    
                    
                    Error

An incorrect use of memory.

Declaration

Swift

public enum Error : Swift.Error, Regular

Show on GitHub


                    
                    
                    Offset

A position in some allocation.

Declaration

Swift

public typealias Offset = Int

Show on GitHub


                    
                    
                    Storage

The bytes of an Allocation preceded by zero or more bytes of initial padding for alignment purposes.

Declaration

Swift

public typealias Storage = [UInt8]

Show on GitHub


                    
                    
                    Allocation

A usable region.

Declaration

Swift

public struct Allocation

Show on GitHub


                    
                    
                    Address

A memory location.

Declaration

Swift

public struct Address : Regular, CustomStringConvertible

Show on GitHub


                    
                    
                    allocation

The live allocations, by ID

Declaration

Swift

public private(set) var allocation: [Allocation.ID : Allocation] { get }

Show on GitHub


                    
                    
                    nextAllocation

The ID of the next allocated block.

Declaration

Swift

private var nextAllocation: Int

Show on GitHub


                    
                    
                    allocate(_:bytesWithAlignment:)

Allocates n bytes with alignment m.

Declaration

Swift

public mutating func allocate(_ n: Int, bytesWithAlignment m: Int) -> Address

Show on GitHub


                    
                    
                    deallocate(_:)

Deallocates the allocated memory starting at a.

Declaration

Swift

public mutating func deallocate(_ a: Address) throws

Show on GitHub


                    
                    
                    compose(_:at:)

Replaces the initialization records starting at a for the parts of a t instance, with the initialization record for a t instance.

Declaration

Swift

public mutating func compose(_ t: TypeLayout, at a: Address) throws

Show on GitHub


                    
                    
                    address(_:hasAlignment:)

Returns true if a is aligned to an n byte boundary.

Declaration

Swift

public func address(_ a: Address, hasAlignment n: Int) -> Bool

Show on GitHub


                    
                    
                    decompose(_:at:)

Replaces the initialization record for a t instance at a with the initialization records for any parts of that instance.

Declaration

Swift

public mutating func decompose(_ t: TypeLayout, at a: Address) throws

Show on GitHub


                    
                    
                    checkDecomposable(_:at:)

Undocumented

Declaration

Swift

private func checkDecomposable(_ t: TypeLayout, at a: Address) throws -> Allocation.ComposedRegions.Index

Show on GitHub


                    
                    
                    subscript(_:)

The allocation identified by i.

Declaration

Swift

public subscript(i: Allocation.ID) -> Allocation { get set }

Show on GitHub


                    
                    
                    deallocate(_:)

Deallocates the allocated memory at a, leaving it deallocated and rendering a unusable for any purpose.

Declaration

Swift

mutating func deallocate(_ a: ModuleScope.Address) throws

Show on GitHub