gdドキュメント0.8.0

APIリファレンス

GDLRUCache

最近使った値を、件数と有効期限を指定して保存するキャッシュです。必要な値がなければ作成して返せます。

メソッド

setup

setup(limit: int, ttl_ms: int = 0) -> void
英語原文

Configure capacity and TTL.

引数

名前型省略時の値説明
limitint省略不可キャッシュに保持する項目数の上限。
ttl_msint0項目の有効期間をミリ秒で指定。0は期限切れを無効にします。

戻り値

void

値を返しません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

put

put(key: Variant, value: Variant) -> void
英語原文

Store or replace a cache entry.

引数

名前型省略時の値説明
keyVariant省略不可対象値の選択・保存・認証に使うキー。
valueVariant省略不可保存、変換、検査など、この関数で処理する値。

戻り値

void

値を返しません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

take

take(key: Variant, fallback: Variant = null) -> Variant
英語原文

Look up a key or return the fallback.

引数

名前型省略時の値説明
keyVariant省略不可対象値の選択・保存・認証に使うキー。
fallbackVariantnull対象の値が存在しないか省略された場合に使う値。

戻り値

Variant

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

fetch

fetch(key: Variant, make: Callable) -> Variant
英語原文

Load a missing key through the factory, cache it, and return it.

引数

名前型省略時の値説明
keyVariant省略不可対象値の選択・保存・認証に使うキー。
makeCallable省略不可値がキャッシュにないときに生成するCallable。

戻り値

Variant

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

has

has(key: Variant) -> bool
英語原文

Check existence without refreshing access order, removing expired entries.

引数

名前型省略時の値説明
keyVariant省略不可対象値の選択・保存・認証に使うキー。

戻り値

bool

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

erase

erase(key: Variant) -> void
英語原文

Remove one entry.

引数

名前型省略時の値説明
keyVariant省略不可対象値の選択・保存・認証に使うキー。

戻り値

void

値を返しません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

clear

clear() -> void
英語原文

Clear entries and reset counters.

引数

引数はありません。

戻り値

void

値を返しません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

size

size() -> int
英語原文

Return the number of entries currently retained in the cache.

引数

引数はありません。

戻り値

int

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

limit

limit() -> int
英語原文

Return the configured maximum number of retained entries.

引数

引数はありません。

戻り値

int

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

hit_count

hit_count() -> int
英語原文

Return the accumulated count of successful cache lookups.

引数

引数はありません。

戻り値

int

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

miss_count

miss_count() -> int
英語原文

Return the accumulated count of lookups whose key was absent.

引数

引数はありません。

戻り値

int

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

hit_rate

hit_rate() -> float
英語原文

Return the hit ratio from zero to one.

引数

引数はありません。

戻り値

float

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。