package core:container/lru
Source

Index

Types (2)
Constants (0)

This section is empty.

Variables (0)

This section is empty.

Procedure Groups (0)

This section is empty.

Types

Cache ¶
Source

Cache :: struct($Key: typeid, $Value: typeid) where intrinsics.type_is_valid_map_key(Key) {}
 

Cache is an LRU cache. It automatically removes entries as new entries are added if the capacity is reached. Entries are removed based on how recently they were used where the oldest entries are removed first.

Node ¶
Source

Node :: struct($Key: typeid, $Value: typeid) where intrinsics.type_is_valid_map_key(Key) {}

Constants

This section is empty.

Variables

This section is empty.

Procedures

clear ¶
Source

clear :: proc "odin" (c: ^$C/Cache($Key, $Value), call_on_remove: bool) {…}
 

clear the contents of a Cache

destroy ¶
Source

destroy :: proc "odin" (c: ^$C/Cache($Key, $Value), call_on_remove: bool) {…}
 

destroy deinitializes a Cachem

exists ¶
Source

exists :: proc "odin" (c: ^$C/Cache($Key, $Value), key: $T) -> bool {…}
 

exists checks for the existence of a value from a given key without updating the recent usage.

get ¶
Source

get :: proc "odin" (c: ^$C/Cache($Key, $Value), key: $T) -> (value: $T, ok: bool) #optional_ok {…}
 

get a value from the cache from a given key. This operation updates the usage of the item.

get_ptr ¶
Source

get_ptr :: proc "odin" (c: ^$C/Cache($Key, $Value), key: $T) -> (value: ^$T, ok: bool) #optional_ok {…}
 

get_ptr gets the pointer to a value the cache from a given key. This operation updates the usage of the item.

init ¶
Source

init :: proc "odin" (c: ^$C/Cache($Key, $Value), capacity: int, entries_allocator := context.allocator, node_allocator := context.allocator) {…}
 

init initializes a Cache

peek ¶
Source

peek :: proc "odin" (c: ^$C/Cache($Key, $Value), key: $T) -> (value: $T, ok: bool) #optional_ok {…}
 

peek gets the value from the cache from a given key without updating the recent usage.

remove ¶
Source

remove :: proc "odin" (c: ^$C/Cache($Key, $Value), key: $T) -> bool {…}
 

remove removes an item from the cache.

set ¶
Source

set :: proc "odin" (c: ^$C/Cache($Key, $Value), key: $T, value: $T) -> runtime.Allocator_Error {…}
 

set the given key value pair. This operation updates the recent usage of the item.

Procedure Groups

This section is empty.

Source Files

Generation Information

Generated with odin version dev-2023-03 (vendor "odin") Windows_amd64 @ 2023-03-29 21:09:05.418672400 +0000 UTC