SharedTable

消すリアする SharedTable 。

戻り値

()

clone

クローンの SharedTable を作成し、クローンを返します。

オプションの deep 引数が存在しない場合、または存在して値が false である場合、浅いクローンが作成されます。浅いクローンはトップレベルの SharedTable オブジェクトのみをコピーします。If any value in the SharedTable itself is a SharedTable , then both the original SharedTable and the clone SharedTable will refer to the same SharedTable .

浅いクローン操作はアトミックであるため、クローン SharedTable には、他のスクリプトから同時に修正されているにもかかわらず、オリジナルの SharedTable の状態の一貫したスナップショットが含まれます。

オプションの deep 引数が存在し、その値が true である場合、深いクローンが作成されます。深いクローンは、SharedTable オブジェクトの構造を再帰的にコピーし、オリジナルの SharedTable とクローンの間で共有される状態がないようにします。

グラフ内の各オブジェクトのクローンは原子ですが、深いクローン全体は原子ではありません。たとえば、グラフ内の各 SharedTable のクローンには、クローンされたオリジナルの SharedTable オブジェクトの一貫したスナップショットが含まれますが、グラフが他のスクリプトで同時に修正されている場合、異なる SharedTable オブジェクトの状態が不一致する可能性があります。

クローンされている SharedTable オブジェクト(s)は、フリーズされるか、そうでないかもしれません。どちらにしても、新たに作成されたクローンは 凍結されていない (そしてそれらは変更可能)。凍結クローンを作成するには、SharedTable.cloneAndFreeze 関数を使用します。

浅いクローンと深いクローンの違いを示すために、次のサンプルを考えてください。この最初のサンプルは浅いクローンを作成し、2番目は深いクローンを作成します。

パラメータ

クローンする SharedTable オブジェクト。

deep: boolean

深いクローン (）または浅いクローン (）を作成するかどうか。

既定値: false

戻り値

コードサンプル

このコードサンプルは、SharedTable の浅いクローンを作成します。

浅いクローン

local original = SharedTable.new()
original["a"] = "original a"
original["b"] = "original b"
original["c"] = SharedTable.new()
original["c"]["d"] = "original d"

local clone = SharedTable.clone(original, false)
clone["a"] = "new a"
clone["b"] = "new b"
clone["c"]["d"] = "new d"
assert(original["a"] == "original a")
assert(original["b"] == "original b")

-- これが浅いクローンだったので、original["c"] と clone["c"] は
-- 同じ共有テーブルオブジェクト。
assert(original["c"] == clone["c"])
assert(original["c"]["d"] == "new d")

This code sample creates a deep clone of a SharedTable.

Deep Clone

local original = SharedTable.new()
original["a"] = "original a"
original["b"] = "original b"
original["c"] = SharedTable.new()
original["c"]["d"] = "original d"

local clone = SharedTable.clone(original, true)
clone["a"] = "new a"
clone["b"] = "new b"
clone["c"]["d"] = "new d"
assert(original["a"] == "original a")
assert(original["b"] == "original b")

-- Because this was a deep clone, clone["c"] is a clone of original["c"];
-- they are distinct SharedTable objects.
assert(original["c"] ~= clone["c"])
assert(original["c"]["d"] == "original d")

cloneAndFreeze

クリーンな (読み込み専用) クローンを作成し、SharedTable を返します。この機能の動作は、クローンの動作と同じですが、クローンが凍結されています。

深いクローンがリクエストされると、クローンされたすべての SharedTable オブジェクトが凍結します。

パラメータ

クローンする共有テーブルオブジェクト。

deep: boolean

深いクローン (）または浅いクローン (）を作成するかどうか。

既定値: false

戻り値

increment

アトミックに要素の値を増加します。指定されたキーを持つ要素は、SharedTable で存在し、タイプは number でなければなりません。指定された delta は値に追加され、元の値が返されます。

この目的でも SharedTable.update 関数を使用できます;この increment 関数は便利性とパフォーマンスのために存在します (一全般に、increment は update よりもはるかに速いので、可能な限り優先する必要があります)。次の 2 つの機能呼び出しは同じ効果があります：


local st = SharedTable.new()
st["x"] = 1

local oldValue = SharedTable.increment(st, "x", 1)

SharedTable.update(st, "x", function(v)
    oldValue = v
    return v + 1
end)

SharedTable が凍結された場合、操作に失敗してエラーが発生します。

パラメータ

更新する SharedTable オブジェクト。

key: string | number

SharedTable オブジェクトで更新する要素のキー。

delta: number

SharedTable の要素に追加する値。

戻り値

delta が追加される前の要素のオリジナル値。

コードサンプル

This code sample demonstrates usage of SharedTable.increment().

Increment

local st = SharedTable.new()
st["x"] = 1

local oldValue = SharedTable.increment(st, "x", 1)
assert(oldValue == 1)
assert(st["x"] == 2)

-- The value of the specified key must be a number.  If it is not a
-- number, the call will fail:
st["y"] = "test"
assert(not pcall(function() SharedTable.increment(st, "y", 1) end))

isFrozen

boolean

true が凍結 (読み取り専用) されている場合、SharedTable を返します。


local st1 = SharedTable.new({"a", "b", "c"})
assert(not SharedTable.isFrozen(st1))

local st2 = SharedTable.cloneAndFreeze(st1)
assert(SharedTable.isFrozen(st2))

パラメータ

SharedTable 凍結状態がクエリされる予定のオブジェクト。

戻り値

boolean

size

共有テーブルに保存された要素の数を返します。注: 他のスクリプトが同時に共有テーブルを変更している場合、返されたサイズは、他のスクリプトが共有テーブルから要素を追加または削除した後、正しくなくなる可能性があります。


local st = SharedTable.new({"a", "b", "c"})
assert(SharedTable.size(st) == 3)

st[2] = nil
assert(SharedTable.size(st) == 2)

パラメータ

サイズがクエリーされる予定の SharedTable オブジェクト。

戻り値

update

()

アトミックに要素の値を更新します。

異なる実行コンテキストで実行されているスクリプトから同時にアクセスすると、SharedTable のアクセスが予測できない形で交差する可能性があります。このため、次のようなコードは一般的に間違っています、値が最初の行で読み込まれてから、2番目の行で更新される可能性があるため:


local oldValue = st["x"]
st["x"] = oldValue .. ",x"

アップデート機能により、要素にアトミックアップデートを実行できます。現在の要素の値で呼び出す機能が必要です。その後、機能は新しい値を計算して返します。注: 機能は、SharedTable が他のスクリプトから同時に変更されている場合、複数回呼び出される可能性があります。

SharedTable が凍結された場合、操作に失敗してエラーが発生します。

パラメータ