Allocation Structure Reference

ID

A unique Allocation identifier.

Declaration

Swift

public typealias ID = Int

Show on GitHub


                    
                    
                    storage

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

Declaration

Swift

var storage: Storage

Show on GitHub


                    
                    
                    baseOffset

The number of bytes in storage before self logically begins.

Declaration

Swift

public let baseOffset: Offset

Show on GitHub


                    
                    
                    size

The number of usable bytes of self.

Declaration

Swift

public let size: Int

Show on GitHub

id

The identity of self, unique throughout time for a given Memory.

Declaration

Swift

public let id: ID

Show on GitHub


                    
                    
                    ComposedRegion

A region of some allocation that contains a complete instance of some type, ready to be a part of a new composition.

See compose(:at:).

Declaration

Swift

public struct ComposedRegion : Regular

Show on GitHub


                    
                    
                    ComposedRegions

The composed regions of an Allocation.

Declaration

Swift

fileprivate typealias ComposedRegions = [ComposedRegion]

Show on GitHub


                    
                    
                    composedRegions

The composed regions, in ascending order.

Declaration

Swift

private var composedRegions: Memory.Allocation.ComposedRegions

Show on GitHub


                    
                    
                    init(_:bytesWithAlignment:id:)

n bytes with alignment m and the given id.

Declaration

Swift

public init(_ n: Int, bytesWithAlignment m: Int, id: ID)

Show on GitHub


                    
                    
                    address(at:)

The address of the oth byte.

Declaration

Swift

private func address(at o: Offset) -> Address

Show on GitHub


                    
                    
                    requireComposed(part:baseOffset:region:)

Throws iff the given part of some type at baseOffset is not represented as the nth composed region.

Declaration

Swift

public func requireComposed(
  part: TypeLayout.Part.Parentage,
  baseOffset: Offset,
  region n: Int
) throws

Show on GitHub


                    
                    
                    checkAlignmentAndAllocationBounds(at:for:)

Throws iff there is not enough allocated space for a t at a, or if it would not be properly aligned.

Declaration

Swift

fileprivate func checkAlignmentAndAllocationBounds(at a: Offset, for t: TypeLayout) 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: Offset) throws

Show on GitHub


                    
                    
                    withUnsafeMutablePointer(to:at:_:)

Returns the result of calling body on the storage for a T instance at a.

Precondition

the storage exists and is properly aligned.

Declaration

Swift

mutating func withUnsafeMutablePointer<T, R>(
  to _: T.Type, at a: Offset, _ body: (UnsafeMutablePointer<T>)->R
) -> R

Show on GitHub


                    
                    
                    withUnsafePointer(to:at:_:)

Returns the result of calling body on the storage for a T instance at a.

Precondition

the storage exists and is properly aligned.

Declaration

Swift

func withUnsafePointer<T, R>(
  to _: T.Type, at a: Offset, _ body: (UnsafePointer<T>)->R
) -> R

Show on GitHub


                    
                    
                    unsignedIntValue(at:ofType:)

Returns the unsigned interpretation of the builtin integer value at a;

Declaration

Swift

private func unsignedIntValue(at a: Offset, ofType t: BuiltinType) -> UInt

Show on GitHub


                    
                    
                    initialize(_:at:to:)

Initializes the raw storage of builtin integer type t at a to x.

Note

performs no alignment, size, initialization, or type checking. Use with care!

Declaration

Swift

internal mutating func initialize(_ t: BuiltinType, at a: Offset, to x: UInt)

Show on GitHub


                    
                    
                    offset(_:hasAlignment:)

Returns true iff o is aligned to an n byte boundary.

Declaration

Swift

public func offset(_ o: Offset, hasAlignment n: Int) -> Bool

Show on GitHub


                    
                    
                    decomposable(_:at:)

Returns the region index of the top-level composed instance of t at a, if any, or nil otherwise.

Declaration

Swift

fileprivate func decomposable(_ t: TypeLayout, at a: Offset) -> ComposedRegions.Index?

Show on GitHub


                    
                    
                    decompose(_:inRegion:)

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

Declaration

Swift

fileprivate mutating func decompose(_ t: TypeLayout, inRegion i: ComposedRegions.Index)

Show on GitHub