APIリファレンス
GDLRUCache
最近使った値を、件数と有効期限を指定して保存するキャッシュです。必要な値がなければ作成して返せます。
メソッド
setup(limit: int, ttl_ms: int = 0) -> voidput(key: Variant, value: Variant) -> voidtake(key: Variant, fallback: Variant = null) -> Variantfetch(key: Variant, make: Callable) -> Varianthas(key: Variant) -> boolerase(key: Variant) -> voidclear() -> voidsize() -> intlimit() -> inthit_count() -> intmiss_count() -> inthit_rate() -> float
setup
setup(limit: int, ttl_ms: int = 0) -> void英語原文Configure capacity and TTL.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
limit | int | 省略不可 | キャッシュに保持する項目数の上限。 |
ttl_ms | int | 0 | 項目の有効期間をミリ秒で指定。0は期限切れを無効にします。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
put
put(key: Variant, value: Variant) -> void英語原文Store or replace a cache entry.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
key | Variant | 省略不可 | 対象値の選択・保存・認証に使うキー。 |
value | Variant | 省略不可 | 保存、変換、検査など、この関数で処理する値。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
take
take(key: Variant, fallback: Variant = null) -> Variant英語原文Look up a key or return the fallback.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
key | Variant | 省略不可 | 対象値の選択・保存・認証に使うキー。 |
fallback | Variant | null | 対象の値が存在しないか省略された場合に使う値。 |
戻り値
Variant
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
fetch
fetch(key: Variant, make: Callable) -> Variant英語原文Load a missing key through the factory, cache it, and return it.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
key | Variant | 省略不可 | 対象値の選択・保存・認証に使うキー。 |
make | Callable | 省略不可 | 値がキャッシュにないときに生成するCallable。 |
戻り値
Variant
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
has
has(key: Variant) -> bool英語原文Check existence without refreshing access order, removing expired entries.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
key | Variant | 省略不可 | 対象値の選択・保存・認証に使うキー。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
erase
erase(key: Variant) -> void英語原文Remove one entry.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
key | Variant | 省略不可 | 対象値の選択・保存・認証に使うキー。 |
戻り値
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を返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。