core/container/pool package | Odin Programming Language

Collection Info

View Source

Collection: core
Path: container/pool
Entries: 10

Constants 1

Types 2

Procedures 7

cap destroy get init num_outstanding num_ready put

Procedure Groups 0

Variables 0

Source Files

Constants

DEFAULT_BLOCK_SIZE #

Source

DEFAULT_BLOCK_SIZE :: _DEFAULT_BLOCK_SIZE

Types

Pool #

Source

Pool :: Pool

A thread-safe (between init and destroy) object pool backed by virtual growing arena returning stable pointers. The element type requires an intrusive link node. Example: Elem :: struct { link: ^Elem, } p: pool.Pool(Elem) pool.init(&p, "link")

Pool_Arena #

Source

Pool_Arena :: Arena

Procedures

cap #

Source

cap :: proc(p: ^Pool($T)) -> int {…}

destroy #

Source

destroy :: proc(p: ^Pool($T)) {…}

get #

Source

@(require_results)

get :: proc(p: ^Pool($T)) -> (elem: $$deferred_return, err: Allocator_Error) #optional_ok {…}

init #

Source

@(require_results)

init :: proc(p: ^Pool($T), $link_field: string, block_size: uint = DEFAULT_BLOCK_SIZE) -> (err: Allocator_Error) {…}

num_outstanding #

Source

num_outstanding :: proc(p: ^Pool($T)) -> int {…}

num_ready #

Source

num_ready :: proc(p: ^Pool($T)) -> int {…}

put #

Source

put :: proc(p: ^Pool($T), elem: ^$T) {…}