docs / stdlib

Stdlib index
  1. Overview
  1. Captured-borrow migration worklist (3.3.3)
  2. Owned-bind migration worklist (8.2.7)
  3. Return-side title audit — the ride-through enumeration
  4. stdlib ownership audit
  5. stdlib ownership dispositions (plan 1.3.1 / 4.3.1)

codec

  1. Base64

codec / csv

  1. Csv

codec / json

  1. Json

collection

  1. ArrayList
  2. BPlusTree
  3. Cache
  4. Collectors
  5. HashMap
  6. HashSet
  7. Heap
  8. ImmutableList
  9. ImmutableMap
  10. ImmutableSet
  11. LinkedList
  12. RedBlackTree
  13. Sort

collection / ltm

  1. LtmBPlusTree

concurrent

  1. AtomicInt32
  2. AtomicInt64
  3. Channel
  4. FiberLocal
  5. Lock
  6. Mutex
  7. RwLock
  8. Semaphore
  9. Tasks

error

  1. Exception
  2. NoOptionalValueException
  3. RecoverableException
  4. Throwable
  5. UnrecoverableException

gfx

  1. Sampler
  2. Texture2D

hash

  1. Blake3
  2. DefaultHasher
  3. Hash
  4. MD5
  5. Sha1
  6. Sha256
  7. SipHash
  8. XXHash3

ifx

  1. BackendRegistry
  2. Window

io

  1. Buffer

io / file

  1. File
  2. FileInfo
  3. FileReader
  4. FileWriter
  5. Path
  6. Watcher

io / net

  1. IpAddress
  2. Server
  3. ServerBuilder
  4. SocketAddress
  5. TcpListener
  6. TcpStream
  7. UdpSocket

io / net / dns

  1. Dns

io / net / tls

  1. TlsConnection
  2. TlsListener

io / net / uri

  1. Uri
  2. UriBuilder

lang

  1. Guid
  2. Math
  3. Optional
  4. Pair
  5. Slice
  6. String
  7. StringBuilder

lang / stream

  1. ArrayStream
  2. Stream

math

  1. Camera
  2. Color
  3. DType
  4. Ray
  5. Rotation
  6. Tensor
  7. Transform

math / fft

  1. Fft

math / linalg

  1. LinAlg

math / npio

  1. Npy

math / poly

  1. Poly

math / random

  1. Generator

math / stats

  1. Stats

nucleo

  1. Columns — the Arrow-laid-out substrate
  2. Fused tensor expressions — Fuse
  3. Table — the lazy, typed dataframe
  4. Tape — define-by-run autograd
  5. Transform intrinsics — Grad, Vmap, Jit

process

  1. Command
  2. Process

reflect

  1. Class

search / distance

  1. Distance

search / fuzzy

  1. Matcher

search / ngram

  1. Index

session

  1. PackageInstallException
  2. Packages

time

  1. Clock
  2. DateTimeFormatter
  3. Duration
  4. Instant
  5. LocalDate
  6. LocalDateTime
  7. LocalTime
  8. Period
  9. ZonedDateTime
  10. ZoneId
  11. ZoneOffset

wire

  1. Compressor
  2. Decompressor
  3. Encoder
  4. Schema
  5. SchemaEncoder

xpu

  1. Device
  2. KernelBuffer
  3. KernelStream

xpu / mesh

  1. MeshSimplifier

stdlib ownership audit

Generated by tools/ownership/audit_ownership.py; see specs/stdlib-ownership-convention-spec.md.

KindCount
CAPTURE(#=)45
CAPTURE(elem)6
CONDITIONAL1
VIEW-RETURN106

CAPTURE(#=)

FileMethodTypeNote
codec/json/JsonLinesWriter.cajetaJsonLinesWriterFileWritersink — sink model; legitimate only if this type IS a sink (2.3)
collection/CacheNode.cajetaCacheNodeKkey — sink model; legitimate only if this type IS a sink (2.3)
collection/CacheNode.cajetaCacheNodeVvalue — sink model; legitimate only if this type IS a sink (2.3)
collection/LinkedListNode.cajetaLinkedListNodeTvalue — sink model; legitimate only if this type IS a sink (2.3)
collection/RedBlackNode.cajetaRedBlackNodeKkey — sink model; legitimate only if this type IS a sink (2.3)
collection/RedBlackNode.cajetaRedBlackNodeVvalue — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmBPlusTree.cajetaLtmBPlusTreeBufferEncoder<K>keyFast — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmBPlusTree.cajetaLtmBPlusTreeBufferEncoder<V>valFast — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmBPlusTree.cajetaLtmBPlusTreeEncoder<K>keyEnc — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmBPlusTree.cajetaLtmBPlusTreeEncoder<K>keyEnc — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmBPlusTree.cajetaLtmBPlusTreeEncoder<V>valEnc — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmBPlusTree.cajetaLtmBPlusTreeEncoder<V>valEnc — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmPager.cajetaLtmPagerEncoder<K>keyEnc — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmPager.cajetaLtmPagerEncoder<V>valEnc — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmPager.cajetasetBufferEncodersBufferEncoder<K>keyFast — sink model; legitimate only if this type IS a sink (2.3)
collection/ltm/LtmPager.cajetasetBufferEncodersBufferEncoder<V>valFast — sink model; legitimate only if this type IS a sink (2.3)
concurrent/FiberLocalBox.cajetaFiberLocalBoxTvalue — sink model; legitimate only if this type IS a sink (2.3)
concurrent/Mutex.cajetaMutexTinitial — sink model; legitimate only if this type IS a sink (2.3)
concurrent/RwLock.cajetaRwLockTinitial — sink model; legitimate only if this type IS a sink (2.3)
concurrent/SelectResult.cajetaSelectResultTvalue — sink model; legitimate only if this type IS a sink (2.3)
io/file/FileEvent.cajetaFileEventPathpath — sink model; legitimate only if this type IS a sink (2.3)
io/file/FileEvent.cajetaFileEventPathrenameTarget — sink model; legitimate only if this type IS a sink (2.3)
io/net/AsyncReader.cajetaAsyncReaderByteChannelstream — sink model; legitimate only if this type IS a sink (2.3)
io/net/AsyncReader.cajetaAsyncReaderByteChannelstream — sink model; legitimate only if this type IS a sink (2.3)
io/net/AsyncWriter.cajetaAsyncWriterByteChannelstream — sink model; legitimate only if this type IS a sink (2.3)
io/net/AsyncWriter.cajetaAsyncWriterByteChannelstream — sink model; legitimate only if this type IS a sink (2.3)
io/net/ServerBuilder.cajetabindAddressSocketAddressaddr — sink model; legitimate only if this type IS a sink (2.3)
io/net/ServerBuilder.cajetamodelServerModelm — sink model; legitimate only if this type IS a sink (2.3)
lang/Optional.cajetaOptionalTvalue — sink model; legitimate only if this type IS a sink (2.3)
lang/stream/ArrayStream.cajetaArrayStreamT[]data — sink model; legitimate only if this type IS a sink (2.3)
math/Tensor.cajetaTensorStorage<T>store — sink model; legitimate only if this type IS a sink (2.3)
math/TensorProtocol.cajetaTensorProtocolDTypedtype — sink model; legitimate only if this type IS a sink (2.3)
math/TensorProtocol.cajetaTensorProtocolObjectbase — sink model; legitimate only if this type IS a sink (2.3)
math/optim/OptimResult.cajetaOptimResultTensor<float64>x — sink model; legitimate only if this type IS a sink (2.3)
nucleo/column/Column.cajetaColumnTensor<T>root — sink model; legitimate only if this type IS a sink (2.3)
nucleo/column/MxColumn.cajetaMxColumnColumn<uint8>packed — sink model; legitimate only if this type IS a sink (2.3)
nucleo/column/NullableColumn.cajetaNullableColumnColumn<T>values — sink model; legitimate only if this type IS a sink (2.3)
nucleo/column/NullableColumn.cajetaNullableColumnColumn<uint8>validity — sink model; legitimate only if this type IS a sink (2.3)
nucleo/column/StringColumn.cajetaStringColumnColumn<int32>offsets — sink model; legitimate only if this type IS a sink (2.3)
nucleo/column/StringColumn.cajetaStringColumnColumn<uint8>data — sink model; legitimate only if this type IS a sink (2.3)
nucleo/frame/DynFrame.cajetasetSpatialStringx — sink model; legitimate only if this type IS a sink (2.3)
nucleo/frame/DynFrame.cajetasetSpatialStringy — sink model; legitimate only if this type IS a sink (2.3)
nucleo/transform/GradResult.cajetaGradResultGgrads — sink model; legitimate only if this type IS a sink (2.3)
nucleo/transform/GradResult.cajetaGradResultVvalue — sink model; legitimate only if this type IS a sink (2.3)
search/fuzzy/Match.cajetaMatchTvalue — sink model; legitimate only if this type IS a sink (2.3)

CAPTURE(elem)

FileMethodTypeNote
collection/ArrayList.cajetaaddTv — stored into an element
collection/ArrayList.cajetainsertTv — stored into an element
collection/ArrayList.cajetasetTv — stored into an element
collection/Heap.cajetapushTv — stored into an element
math/Storage.cajetasetTv — stored into an element
nucleo/frame/DynFrame.cajetaaddIndexedStringname — stored into an element

CONDITIONAL

FileMethodTypeNote
codec/json/JsonValue.cajetasetStringBorrowedJsonValuebranches between owned and borrowed paths

VIEW-RETURN

FileMethodTypeNote
buildtool/plugin/ActionResult.cajetaerrorMessageString
buildtool/plugin/ActionResult.cajetafindingsArrayList<Finding>
buildtool/plugin/ActionResult.cajetaoutputsHashMap<String, String>
buildtool/plugin/Finding.cajetafileString
buildtool/plugin/Finding.cajetamessageString
buildtool/plugin/Finding.cajetaruleString
codec/json/JsonArray.cajetagetJsonValue
codec/json/JsonObject.cajetagetJsonValue
codec/json/JsonObject.cajetavalueAtJsonValue
codec/json/JsonValue.cajetaarrayJsonArray
codec/json/JsonValue.cajetaobjectJsonObject
collection/ArrayList.cajetagetT
collection/HashMap.cajetagetV
collection/Heap.cajetapeekT
collection/ImmutableList.cajetagetT
collection/ImmutableMap.cajetagetV
collection/ImmutableMap.cajetakeyAtK
collection/ImmutableMap.cajetavalAtV
collection/ImmutableSet.cajetagetT
collection/graph/Digraph.cajetaengineIndexGraph
error/Throwable.cajetagetMessageString
ifx/IfxInfo.cajetaaudioBackendNameString
ifx/IfxInfo.cajetainputBackendNameString
ifx/IfxInfo.cajetawindowBackendNameString
io/net/Headers.cajetanameAtString
io/net/Headers.cajetavalueAtString
io/net/RecvResult.cajetagetFromSocketAddress
io/net/SocketAddress.cajetagetIpIpAddress
io/net/uri/Uri.cajetagetFragmentString
io/net/uri/Uri.cajetagetHostString
io/net/uri/Uri.cajetagetPathString
io/net/uri/Uri.cajetagetQueryString
io/net/uri/Uri.cajetagetSchemeString
io/net/uri/Uri.cajetagetUserinfoString
lang/Optional.cajetagetT
lang/Optional.cajetaorElseT
lang/Pair.cajetafirstK
lang/Pair.cajetasecondV
lang/stream/FilterStream.cajetaunwrapStream<?>
lang/stream/FlatMapStream.cajetaunwrapStream<?>
lang/stream/MapOrFallbackStream.cajetaunwrapStream<?>
lang/stream/MapOrLogStream.cajetaunwrapStream<?>
lang/stream/MapOrSkipStream.cajetaunwrapStream<?>
lang/stream/MapStream.cajetaunwrapStream<?>
lang/stream/PeekStream.cajetaunwrapStream<?>
lang/stream/SkipStream.cajetaunwrapStream<?>
lang/stream/TakeStream.cajetaunwrapStream<?>
math/Storage.cajetadeviceBufferKernelBuffer<T>
math/Storage.cajetagetT
math/Tensor.cajetabaseTensor<T>
math/TensorProtocol.cajetabaseObject
math/TensorProtocol.cajetadtypeDType
nucleo/frame/Agg.cajetaexprOfColF64
nucleo/frame/Agg.cajetaiRefOfColI64
nucleo/frame/Agg.cajetaleftAggAgg
nucleo/frame/Agg.cajetanextOfAgg
nucleo/frame/Agg.cajetaoutNameOfString
nucleo/frame/Agg.cajetarightAggAgg
nucleo/frame/Agg.cajetastrRefOfColStr
nucleo/frame/ColF64.cajetaleftChildColF64
nucleo/frame/ColF64.cajetanameString
nucleo/frame/ColF64.cajetarightChildColF64
nucleo/frame/ColI64.cajetanameString
nucleo/frame/ColStr.cajetanameString
nucleo/frame/DynFrame.cajetacolAtDynCol
nucleo/frame/DynFrame.cajetaindexedAtString
nucleo/frame/DynFrame.cajetanameAtString
nucleo/frame/DynFrame.cajetaspatialXOfString
nucleo/frame/DynFrame.cajetaspatialYOfString
nucleo/frame/Plan.cajetaaggsOfAgg
nucleo/frame/Plan.cajetachildOfPlan
nucleo/frame/Plan.cajetacolNameOfString
nucleo/frame/Plan.cajetajoinKeysOfSel
nucleo/frame/Plan.cajetajoinOutOfDynFrame
nucleo/frame/Plan.cajetakeysOfSel
nucleo/frame/Plan.cajetameltIdAtString
nucleo/frame/Plan.cajetameltValAtString
nucleo/frame/Plan.cajetameltValNameOfString
nucleo/frame/Plan.cajetameltVarNameOfString
nucleo/frame/Plan.cajetapredOfPred
nucleo/frame/Plan.cajetarightPlanOfPlan
nucleo/frame/Plan.cajetarightSrcOfDynFrame
nucleo/frame/Plan.cajetaselsOfSel
nucleo/frame/Plan.cajetasortKeysOfSortKey
nucleo/frame/Pred.cajetaiOperandExprColI64
nucleo/frame/Pred.cajetaleftPredicatePred
nucleo/frame/Pred.cajetaoperandExprColF64
nucleo/frame/Pred.cajetarightPredicatePred
nucleo/frame/Pred.cajetastrOperandExprColStr
nucleo/frame/Pred.cajetastrValueString
nucleo/frame/Sel.cajetaexprOfColF64
nucleo/frame/Sel.cajetaiRefOfColI64
nucleo/frame/Sel.cajetanextOfSel
nucleo/frame/Sel.cajetaoutNameOfString
nucleo/frame/Sel.cajetastrRefOfColStr
nucleo/frame/SortKey.cajetaexprOfColF64
nucleo/frame/SortKey.cajetaiRefOfColI64
nucleo/frame/SortKey.cajetanextOfSortKey
nucleo/frame/SortKey.cajetastrRefOfColStr
nucleo/frame/Table.cajetacollectTable<T>
search/fuzzy/Match.cajetakeyString
search/fuzzy/Match.cajetavalueT
time/DateTimeFormatter.cajetagetPatternString
time/ZoneId.cajetagetIdString
xpu/PageCache.cajetaevictedKeyK
xpu/PageCache.cajetagetOrDefaultV

Source: docs/stdlib/ownership-audit.md · 9 min read · 1975 words