offset(of:)

Return Value 戻り値

The offset in bytes from a pointer to a value of type T to a pointer to the storage referenced by key, or nil if no such offset is available for the storage referenced by key. If the value is nil, it can be because key is computed, has observers, requires reabstraction, or overlaps storage with other properties. 型Tの値へのポインタから、keyによって参照されるストレージへのポインタまでのバイトでのオフセット、またはnil、もしそのようなオフセットがkeyによって参照されるストレージに利用可能でないならば。値がnilの場合、それが可能なのはkeyが計算される、オブザーバを持つ、再抽象化を要求する、またはストレージを他のプロパティでオーバーラップするからです。

Discussion 解説

You can use this method to find the distance in bytes that can be added to a pointer of type T to get a pointer to the property referenced by key. The offset is available only if the given key refers to inline, directly addressable storage within the in-memory representation of T. あなたはこのメソッドを使ってバイトでの隔たりを見つけることができます、それは型Tのポインタに加えることで、keyによって参照されるプロパティへのポインタを得ることができるものです。このオフセットは与えられたキーがインラインの、直接にアドレス指定可能なストレージをTのインメモリ表現内で参照する場合にのみ利用可能です。

If the return value of this method is non-nil, then accessing the value by key path or by an offset pointer are equivalent. For example, for a variable root of type T, a key path key of type WritableKeyPath<T, U>, and a value of type U: このメソッドの戻り値が非nilならば、その時その値にキーパスによってまたはあるオフセットポインタによってアクセスすることは、等価です。例えば、変数rootで型T、キーパスkeyで型WritableKeyPath<T, U>、そしてvalueで型Uに対して：

// Mutation through the key path
root[keyPath: key] = value


// Mutation through the offset pointer
withUnsafeMutableBytes(of: &root) { bytes in
    let offset = MemoryLayout<T>.offset(of: key)!
    let rawPointerToValue = bytes.baseAddress! + offset
    let pointerToValue = rawPointerToValue.assumingMemoryBound(to: U.self)
    pointerToValue.pointee = value
}

A property has inline, directly addressable storage when it is a stored property for which no additional work is required to extract or set the value. Properties are not directly accessible if they trigger any didSet or willSet accessors, perform any representation changes such as bridging or closure reabstraction, or mask the value out of overlapping storage as for packed bitfields. In addition, because class instance properties are always stored out-of-line, their positions are not accessible using offset(of:). あるプロパティは、インラインに、直接にアドレス指定可能なストレージを持ちます、それが値を抽出または設定するのに追加的な仕事が要求されない格納プロパティである場合は。プロパティは直接にアクセス可能ではありません、もしそれらが何らかのdidSetまたはwillSetアクセッサの引き金になる、何らかの表現変更の実行たとえばブリッジまたはクロージャ再抽象化など、またはオーバーラップしているストレージの外の値をパックされたビットフィールドとしてマスクするならば。その上、クラスインスタンスプロパティは常にアウトオブラインに格納されることから、それらの位置はoffset(of:)によってアクセス可能ではありません。

For example, in the ProductCategory type defined here, only \.updateCounter, \.identifier, and \.identifier.name refer to properties with inline, directly addressable storage: 例えば、ここで定義されるProductCategory型において、\.updateCounter, \.identifier、そして\.identifier.nameだけがインラインに、直接にアドレス指定可能なストレージでのプロパティを参照します。

struct ProductCategory {
    struct Identifier {
        var name: String              // addressable
    }


    var identifier: Identifier        // addressable
    var updateCounter: Int            // addressable
    var products: [Product] {         // not addressable: didSet handler
        didSet { updateCounter += 1 }
    }
    var productCount: Int {           // not addressable: computed property
        return products.count
    }
}

When using offset(of:) with a type imported from a library, don’t assume that future versions of the library will have the same behavior. If a property is converted from a stored property to a computed property, the result of offset(of:) changes to nil. That kind of conversion is nonbreaking in other contexts, but would trigger a runtime error if the result of offset(of:) is force-unwrapped. offset(of:)をあるライブラリからインポートされる型で使う場合、そのライブラリの将来のバージョンが同じ挙動を持つと決めてかからないでください。プロパティが格納プロパティから計算プロパティに変換されるならば、offset(of:)の結果はnilに変わります。その種の変換は、他の文脈においては非破壊です、しかしoffset(of:)の結果が強制アンラップされるならば実行時エラーの引き金となります。