From 19a25775646c718bc4751ef3f5473d78dc7f94b5 Mon Sep 17 00:00:00 2001 From: despiegk Date: Fri, 7 Feb 2025 12:07:32 +0300 Subject: [PATCH] ... --- .gitignore | 1 - cli/hero.v | 2 +- doc.vsh | 9 +- install_hero.sh | 28 +- vdocs/arrays.md | 452 +++ vdocs/arrays.parallel.md | 32 + vdocs/benchmark.md | 124 + vdocs/bitfield.md | 201 ++ vdocs/builtin.md | 2572 +++++++++++++++++ vdocs/builtin.wchar.md | 61 + vdocs/cli.md | 162 ++ vdocs/clipboard.dummy.md | 42 + vdocs/clipboard.md | 66 + vdocs/clipboard.x11.md | 62 + vdocs/compress.deflate.md | 28 + vdocs/compress.gzip.md | 66 + vdocs/compress.md | 18 + vdocs/compress.szip.md | 106 + vdocs/compress.zlib.md | 28 + vdocs/compress.zstd.md | 148 + vdocs/context.md | 166 ++ vdocs/context.onecontext.md | 52 + vdocs/coroutines.md | 10 + vdocs/crypto.aes.md | 32 + vdocs/crypto.bcrypt.md | 48 + vdocs/crypto.blake2b.md | 100 + vdocs/crypto.blake2s.md | 100 + vdocs/crypto.blake3.md | 50 + vdocs/crypto.blowfish.md | 36 + vdocs/crypto.cipher.md | 90 + vdocs/crypto.des.md | 38 + vdocs/crypto.ecdsa.md | 102 + vdocs/crypto.ed25519.internal.edwards25519.md | 224 ++ vdocs/crypto.ed25519.md | 60 + vdocs/crypto.hmac.md | 14 + vdocs/crypto.internal.subtle.md | 38 + vdocs/crypto.md | 10 + vdocs/crypto.md5.md | 57 + vdocs/crypto.pbkdf2.md | 10 + vdocs/crypto.pem.md | 46 + vdocs/crypto.rand.md | 28 + vdocs/crypto.rc4.md | 24 + vdocs/crypto.scrypt.md | 16 + vdocs/crypto.sha1.md | 50 + vdocs/crypto.sha256.md | 82 + vdocs/crypto.sha3.md | 118 + vdocs/crypto.sha512.md | 92 + vdocs/datatypes.fsm.md | 42 + vdocs/datatypes.md | 510 ++++ vdocs/db.mssql.md | 38 + vdocs/db.mysql.md | 400 +++ vdocs/db.pg.md | 130 + vdocs/db.sqlite.md | 234 ++ vdocs/dl.loader.md | 60 + vdocs/dl.md | 58 + vdocs/dlmalloc.md | 86 + vdocs/encoding.base32.md | 78 + vdocs/encoding.base58.md | 74 + vdocs/encoding.base64.md | 64 + vdocs/encoding.binary.md | 226 ++ vdocs/encoding.csv.md | 144 + vdocs/encoding.hex.md | 14 + vdocs/encoding.html.md | 22 + vdocs/encoding.iconv.md | 30 + vdocs/encoding.leb128.md | 38 + vdocs/encoding.txtar.md | 38 + vdocs/encoding.utf8.east_asian.md | 18 + vdocs/encoding.utf8.md | 82 + vdocs/encoding.xml.md | 124 + vdocs/eventbus.md | 78 + vdocs/flag.md | 212 ++ vdocs/fontstash.md | 158 + vdocs/gg.m4.md | 270 ++ vdocs/gg.md | 476 +++ vdocs/gx.md | 144 + vdocs/hash.crc32.md | 28 + vdocs/hash.fnv1a.md | 38 + vdocs/hash.md | 30 + vdocs/io.md | 150 + vdocs/io.string_reader.md | 86 + vdocs/io.util.md | 22 + vdocs/json.cjson.md | 82 + vdocs/json.md | 22 + vdocs/log.md | 218 ++ vdocs/main.md | 22 + vdocs/maps.md | 38 + vdocs/math.big.md | 224 ++ vdocs/math.bits.md | 174 ++ vdocs/math.complex.md | 198 ++ vdocs/math.easing.md | 134 + vdocs/math.fractions.md | 66 + vdocs/math.internal.md | 112 + vdocs/math.md | 541 ++++ vdocs/math.stats.md | 146 + vdocs/math.unsigned.md | 420 +++ vdocs/math.vec.md | 652 +++++ vdocs/net.conv.md | 58 + vdocs/net.ftp.md | 40 + vdocs/net.html.md | 114 + vdocs/net.http.chunked.md | 10 + vdocs/net.http.file.md | 18 + vdocs/net.http.md | 514 ++++ vdocs/net.http.mime.md | 30 + vdocs/net.mbedtls.md | 142 + vdocs/net.md | 512 ++++ vdocs/net.openssl.md | 82 + vdocs/net.smtp.md | 38 + vdocs/net.socks.md | 26 + vdocs/net.ssl.md | 30 + vdocs/net.unix.md | 174 ++ vdocs/net.urllib.md | 134 + vdocs/net.websocket.md | 240 ++ vdocs/orm.md | 88 + vdocs/os.asset.md | 14 + vdocs/os.cmdline.md | 30 + vdocs/os.filelock.md | 34 + vdocs/os.font.md | 18 + vdocs/os.md | 1075 +++++++ vdocs/os.notify.md | 30 + vdocs/picoev.md | 76 + vdocs/picohttpparser.md | 94 + vdocs/rand.buffer.md | 10 + vdocs/rand.config.md | 22 + vdocs/rand.cuid2.md | 34 + vdocs/rand.md | 394 +++ vdocs/rand.mt19937.md | 42 + vdocs/rand.musl.md | 42 + vdocs/rand.pcg32.md | 42 + vdocs/rand.seed.md | 18 + vdocs/rand.splitmix64.md | 42 + vdocs/rand.sys.md | 46 + vdocs/rand.wyrand.md | 42 + vdocs/rand.xoroshiro128pp.md | 42 + vdocs/readline.md | 49 + vdocs/regex.md | 174 ++ vdocs/runtime.md | 50 + vdocs/semver.md | 71 + vdocs/sokol.audio.md | 133 + vdocs/sokol.gfx.md | 1050 +++++++ vdocs/sokol.memory.md | 30 + vdocs/sokol.sapp.md | 330 +++ vdocs/sokol.sfons.md | 30 + vdocs/sokol.sgl.md | 388 +++ vdocs/stbi.md | 66 + vdocs/strconv.md | 290 ++ vdocs/strings.md | 206 ++ vdocs/strings.textscanner.md | 82 + vdocs/sync.md | 250 ++ vdocs/sync.pool.md | 70 + vdocs/sync.stdatomic.md | 38 + vdocs/term.md | 404 +++ vdocs/term.termios.md | 42 + vdocs/term.ui.md | 146 + vdocs/time.md | 472 +++ vdocs/time.misc.md | 10 + vdocs/toml.ast.md | 126 + vdocs/toml.ast.walker.md | 36 + vdocs/toml.checker.md | 26 + vdocs/toml.decoder.md | 18 + vdocs/toml.input.md | 14 + vdocs/toml.md | 194 ++ vdocs/toml.parser.md | 160 + vdocs/toml.scanner.md | 84 + vdocs/toml.to.md | 14 + vdocs/toml.token.md | 22 + vdocs/toml.util.md | 22 + vdocs/v.ast.md | 2106 ++++++++++++++ vdocs/v.ast.walker.md | 28 + vdocs/v.builder.cbuilder.md | 22 + vdocs/v.builder.golangbuilder.md | 18 + vdocs/v.builder.interpreterbuilder.md | 14 + vdocs/v.builder.jsbuilder.md | 22 + vdocs/v.builder.md | 158 + vdocs/v.builder.nativebuilder.md | 18 + vdocs/v.builder.wasmbuilder.md | 18 + vdocs/v.callgraph.md | 10 + vdocs/v.cflag.md | 52 + vdocs/v.checker.md | 70 + vdocs/v.debug.md | 52 + vdocs/v.depgraph.md | 72 + vdocs/v.dotgraph.md | 50 + vdocs/v.embed_file.md | 46 + vdocs/v.errors.md | 26 + vdocs/v.eval.md | 116 + vdocs/v.fmt.md | 438 +++ vdocs/v.gen.c.md | 174 ++ vdocs/v.gen.golang.md | 394 +++ vdocs/v.gen.js.md | 84 + vdocs/v.gen.js.sourcemap.md | 44 + vdocs/v.gen.js.sourcemap.vlq.md | 14 + vdocs/v.gen.native.md | 290 ++ vdocs/v.gen.wasm.md | 338 +++ vdocs/v.gen.wasm.serialise.md | 50 + vdocs/v.help.md | 14 + vdocs/v.live.executable.md | 18 + vdocs/v.live.md | 22 + vdocs/v.live.sharedlib.md | 10 + vdocs/v.markused.md | 90 + vdocs/v.mathutil.md | 18 + vdocs/v.parser.md | 50 + vdocs/v.pkgconfig.md | 46 + vdocs/v.pref.md | 184 ++ vdocs/v.profile.md | 14 + vdocs/v.reflection.md | 168 ++ vdocs/v.scanner.md | 94 + vdocs/v.token.md | 186 ++ vdocs/v.trace_calls.md | 18 + vdocs/v.transformer.md | 106 + vdocs/v.type_resolver.md | 130 + vdocs/v.util.diff.md | 42 + vdocs/v.util.md | 376 +++ vdocs/v.util.recompilation.md | 14 + vdocs/v.util.version.md | 26 + vdocs/v.util.vflags.md | 14 + vdocs/v.util.vtest.md | 14 + vdocs/v.vcache.md | 58 + vdocs/v.vmod.md | 46 + vdocs/v2.ast.md | 416 +++ vdocs/v2.builder.md | 16 + vdocs/v2.errors.md | 46 + vdocs/v2.gen.v.md | 24 + vdocs/v2.parser.md | 26 + vdocs/v2.pref.md | 26 + vdocs/v2.scanner.md | 26 + vdocs/v2.token.md | 114 + vdocs/v2.types.md | 84 + vdocs/v2.util.md | 48 + vdocs/veb.assets.md | 65 + vdocs/veb.auth.md | 52 + vdocs/veb.csrf.md | 38 + vdocs/veb.md | 331 +++ vdocs/veb.oauth.md | 22 + vdocs/veb.sse.md | 26 + vdocs/vweb.assets.md | 58 + vdocs/vweb.csrf.md | 34 + vdocs/vweb.md | 223 ++ vdocs/vweb.sse.md | 26 + vdocs/wasm.md | 506 ++++ vdocs/x.benchmark.md | 22 + vdocs/x.crypto.chacha20.md | 50 + vdocs/x.crypto.chacha20poly1305.md | 50 + vdocs/x.crypto.poly1305.md | 36 + vdocs/x.crypto.sm4.md | 26 + vdocs/x.encoding.asn1.md | 902 ++++++ vdocs/x.json2.decoder2.md | 26 + vdocs/x.json2.md | 194 ++ vdocs/x.json2.strict.md | 26 + vdocs/x.md | 10 + vdocs/x.sessions.md | 152 + vdocs/x.sessions.vweb2_middleware.md | 17 + vdocs/x.templating.dtm.md | 46 + vdocs/x.ttf.md | 206 ++ 252 files changed, 33086 insertions(+), 12 deletions(-) create mode 100644 vdocs/arrays.md create mode 100644 vdocs/arrays.parallel.md create mode 100644 vdocs/benchmark.md create mode 100644 vdocs/bitfield.md create mode 100644 vdocs/builtin.md create mode 100644 vdocs/builtin.wchar.md create mode 100644 vdocs/cli.md create mode 100644 vdocs/clipboard.dummy.md create mode 100644 vdocs/clipboard.md create mode 100644 vdocs/clipboard.x11.md create mode 100644 vdocs/compress.deflate.md create mode 100644 vdocs/compress.gzip.md create mode 100644 vdocs/compress.md create mode 100644 vdocs/compress.szip.md create mode 100644 vdocs/compress.zlib.md create mode 100644 vdocs/compress.zstd.md create mode 100644 vdocs/context.md create mode 100644 vdocs/context.onecontext.md create mode 100644 vdocs/coroutines.md create mode 100644 vdocs/crypto.aes.md create mode 100644 vdocs/crypto.bcrypt.md create mode 100644 vdocs/crypto.blake2b.md create mode 100644 vdocs/crypto.blake2s.md create mode 100644 vdocs/crypto.blake3.md create mode 100644 vdocs/crypto.blowfish.md create mode 100644 vdocs/crypto.cipher.md create mode 100644 vdocs/crypto.des.md create mode 100644 vdocs/crypto.ecdsa.md create mode 100644 vdocs/crypto.ed25519.internal.edwards25519.md create mode 100644 vdocs/crypto.ed25519.md create mode 100644 vdocs/crypto.hmac.md create mode 100644 vdocs/crypto.internal.subtle.md create mode 100644 vdocs/crypto.md create mode 100644 vdocs/crypto.md5.md create mode 100644 vdocs/crypto.pbkdf2.md create mode 100644 vdocs/crypto.pem.md create mode 100644 vdocs/crypto.rand.md create mode 100644 vdocs/crypto.rc4.md create mode 100644 vdocs/crypto.scrypt.md create mode 100644 vdocs/crypto.sha1.md create mode 100644 vdocs/crypto.sha256.md create mode 100644 vdocs/crypto.sha3.md create mode 100644 vdocs/crypto.sha512.md create mode 100644 vdocs/datatypes.fsm.md create mode 100644 vdocs/datatypes.md create mode 100644 vdocs/db.mssql.md create mode 100644 vdocs/db.mysql.md create mode 100644 vdocs/db.pg.md create mode 100644 vdocs/db.sqlite.md create mode 100644 vdocs/dl.loader.md create mode 100644 vdocs/dl.md create mode 100644 vdocs/dlmalloc.md create mode 100644 vdocs/encoding.base32.md create mode 100644 vdocs/encoding.base58.md create mode 100644 vdocs/encoding.base64.md create mode 100644 vdocs/encoding.binary.md create mode 100644 vdocs/encoding.csv.md create mode 100644 vdocs/encoding.hex.md create mode 100644 vdocs/encoding.html.md create mode 100644 vdocs/encoding.iconv.md create mode 100644 vdocs/encoding.leb128.md create mode 100644 vdocs/encoding.txtar.md create mode 100644 vdocs/encoding.utf8.east_asian.md create mode 100644 vdocs/encoding.utf8.md create mode 100644 vdocs/encoding.xml.md create mode 100644 vdocs/eventbus.md create mode 100644 vdocs/flag.md create mode 100644 vdocs/fontstash.md create mode 100644 vdocs/gg.m4.md create mode 100644 vdocs/gg.md create mode 100644 vdocs/gx.md create mode 100644 vdocs/hash.crc32.md create mode 100644 vdocs/hash.fnv1a.md create mode 100644 vdocs/hash.md create mode 100644 vdocs/io.md create mode 100644 vdocs/io.string_reader.md create mode 100644 vdocs/io.util.md create mode 100644 vdocs/json.cjson.md create mode 100644 vdocs/json.md create mode 100644 vdocs/log.md create mode 100644 vdocs/main.md create mode 100644 vdocs/maps.md create mode 100644 vdocs/math.big.md create mode 100644 vdocs/math.bits.md create mode 100644 vdocs/math.complex.md create mode 100644 vdocs/math.easing.md create mode 100644 vdocs/math.fractions.md create mode 100644 vdocs/math.internal.md create mode 100644 vdocs/math.md create mode 100644 vdocs/math.stats.md create mode 100644 vdocs/math.unsigned.md create mode 100644 vdocs/math.vec.md create mode 100644 vdocs/net.conv.md create mode 100644 vdocs/net.ftp.md create mode 100644 vdocs/net.html.md create mode 100644 vdocs/net.http.chunked.md create mode 100644 vdocs/net.http.file.md create mode 100644 vdocs/net.http.md create mode 100644 vdocs/net.http.mime.md create mode 100644 vdocs/net.mbedtls.md create mode 100644 vdocs/net.md create mode 100644 vdocs/net.openssl.md create mode 100644 vdocs/net.smtp.md create mode 100644 vdocs/net.socks.md create mode 100644 vdocs/net.ssl.md create mode 100644 vdocs/net.unix.md create mode 100644 vdocs/net.urllib.md create mode 100644 vdocs/net.websocket.md create mode 100644 vdocs/orm.md create mode 100644 vdocs/os.asset.md create mode 100644 vdocs/os.cmdline.md create mode 100644 vdocs/os.filelock.md create mode 100644 vdocs/os.font.md create mode 100644 vdocs/os.md create mode 100644 vdocs/os.notify.md create mode 100644 vdocs/picoev.md create mode 100644 vdocs/picohttpparser.md create mode 100644 vdocs/rand.buffer.md create mode 100644 vdocs/rand.config.md create mode 100644 vdocs/rand.cuid2.md create mode 100644 vdocs/rand.md create mode 100644 vdocs/rand.mt19937.md create mode 100644 vdocs/rand.musl.md create mode 100644 vdocs/rand.pcg32.md create mode 100644 vdocs/rand.seed.md create mode 100644 vdocs/rand.splitmix64.md create mode 100644 vdocs/rand.sys.md create mode 100644 vdocs/rand.wyrand.md create mode 100644 vdocs/rand.xoroshiro128pp.md create mode 100644 vdocs/readline.md create mode 100644 vdocs/regex.md create mode 100644 vdocs/runtime.md create mode 100644 vdocs/semver.md create mode 100644 vdocs/sokol.audio.md create mode 100644 vdocs/sokol.gfx.md create mode 100644 vdocs/sokol.memory.md create mode 100644 vdocs/sokol.sapp.md create mode 100644 vdocs/sokol.sfons.md create mode 100644 vdocs/sokol.sgl.md create mode 100644 vdocs/stbi.md create mode 100644 vdocs/strconv.md create mode 100644 vdocs/strings.md create mode 100644 vdocs/strings.textscanner.md create mode 100644 vdocs/sync.md create mode 100644 vdocs/sync.pool.md create mode 100644 vdocs/sync.stdatomic.md create mode 100644 vdocs/term.md create mode 100644 vdocs/term.termios.md create mode 100644 vdocs/term.ui.md create mode 100644 vdocs/time.md create mode 100644 vdocs/time.misc.md create mode 100644 vdocs/toml.ast.md create mode 100644 vdocs/toml.ast.walker.md create mode 100644 vdocs/toml.checker.md create mode 100644 vdocs/toml.decoder.md create mode 100644 vdocs/toml.input.md create mode 100644 vdocs/toml.md create mode 100644 vdocs/toml.parser.md create mode 100644 vdocs/toml.scanner.md create mode 100644 vdocs/toml.to.md create mode 100644 vdocs/toml.token.md create mode 100644 vdocs/toml.util.md create mode 100644 vdocs/v.ast.md create mode 100644 vdocs/v.ast.walker.md create mode 100644 vdocs/v.builder.cbuilder.md create mode 100644 vdocs/v.builder.golangbuilder.md create mode 100644 vdocs/v.builder.interpreterbuilder.md create mode 100644 vdocs/v.builder.jsbuilder.md create mode 100644 vdocs/v.builder.md create mode 100644 vdocs/v.builder.nativebuilder.md create mode 100644 vdocs/v.builder.wasmbuilder.md create mode 100644 vdocs/v.callgraph.md create mode 100644 vdocs/v.cflag.md create mode 100644 vdocs/v.checker.md create mode 100644 vdocs/v.debug.md create mode 100644 vdocs/v.depgraph.md create mode 100644 vdocs/v.dotgraph.md create mode 100644 vdocs/v.embed_file.md create mode 100644 vdocs/v.errors.md create mode 100644 vdocs/v.eval.md create mode 100644 vdocs/v.fmt.md create mode 100644 vdocs/v.gen.c.md create mode 100644 vdocs/v.gen.golang.md create mode 100644 vdocs/v.gen.js.md create mode 100644 vdocs/v.gen.js.sourcemap.md create mode 100644 vdocs/v.gen.js.sourcemap.vlq.md create mode 100644 vdocs/v.gen.native.md create mode 100644 vdocs/v.gen.wasm.md create mode 100644 vdocs/v.gen.wasm.serialise.md create mode 100644 vdocs/v.help.md create mode 100644 vdocs/v.live.executable.md create mode 100644 vdocs/v.live.md create mode 100644 vdocs/v.live.sharedlib.md create mode 100644 vdocs/v.markused.md create mode 100644 vdocs/v.mathutil.md create mode 100644 vdocs/v.parser.md create mode 100644 vdocs/v.pkgconfig.md create mode 100644 vdocs/v.pref.md create mode 100644 vdocs/v.profile.md create mode 100644 vdocs/v.reflection.md create mode 100644 vdocs/v.scanner.md create mode 100644 vdocs/v.token.md create mode 100644 vdocs/v.trace_calls.md create mode 100644 vdocs/v.transformer.md create mode 100644 vdocs/v.type_resolver.md create mode 100644 vdocs/v.util.diff.md create mode 100644 vdocs/v.util.md create mode 100644 vdocs/v.util.recompilation.md create mode 100644 vdocs/v.util.version.md create mode 100644 vdocs/v.util.vflags.md create mode 100644 vdocs/v.util.vtest.md create mode 100644 vdocs/v.vcache.md create mode 100644 vdocs/v.vmod.md create mode 100644 vdocs/v2.ast.md create mode 100644 vdocs/v2.builder.md create mode 100644 vdocs/v2.errors.md create mode 100644 vdocs/v2.gen.v.md create mode 100644 vdocs/v2.parser.md create mode 100644 vdocs/v2.pref.md create mode 100644 vdocs/v2.scanner.md create mode 100644 vdocs/v2.token.md create mode 100644 vdocs/v2.types.md create mode 100644 vdocs/v2.util.md create mode 100644 vdocs/veb.assets.md create mode 100644 vdocs/veb.auth.md create mode 100644 vdocs/veb.csrf.md create mode 100644 vdocs/veb.md create mode 100644 vdocs/veb.oauth.md create mode 100644 vdocs/veb.sse.md create mode 100644 vdocs/vweb.assets.md create mode 100644 vdocs/vweb.csrf.md create mode 100644 vdocs/vweb.md create mode 100644 vdocs/vweb.sse.md create mode 100644 vdocs/wasm.md create mode 100644 vdocs/x.benchmark.md create mode 100644 vdocs/x.crypto.chacha20.md create mode 100644 vdocs/x.crypto.chacha20poly1305.md create mode 100644 vdocs/x.crypto.poly1305.md create mode 100644 vdocs/x.crypto.sm4.md create mode 100644 vdocs/x.encoding.asn1.md create mode 100644 vdocs/x.json2.decoder2.md create mode 100644 vdocs/x.json2.md create mode 100644 vdocs/x.json2.strict.md create mode 100644 vdocs/x.md create mode 100644 vdocs/x.sessions.md create mode 100644 vdocs/x.sessions.vweb2_middleware.md create mode 100644 vdocs/x.templating.dtm.md create mode 100644 vdocs/x.ttf.md diff --git a/.gitignore b/.gitignore index 81379170..5fc1922a 100644 --- a/.gitignore +++ b/.gitignore @@ -25,7 +25,6 @@ dump.rdb output/ *.db .stellar -vdocs/ data.ms/ test_basic cli/hero \ No newline at end of file diff --git a/cli/hero.v b/cli/hero.v index 903add9d..28528e29 100644 --- a/cli/hero.v +++ b/cli/hero.v @@ -31,7 +31,7 @@ fn do() ! { mut cmd := Command{ name: 'hero' description: 'Your HERO toolset.' - version: '2.0.6' + version: '1.0.2' } // herocmds.cmd_run_add_flags(mut cmd) diff --git a/doc.vsh b/doc.vsh index b16ad984..dae8f173 100755 --- a/doc.vsh +++ b/doc.vsh @@ -26,9 +26,9 @@ os.chdir(herolib_path) or { panic('Failed to change directory to herolib: ${err}') } -os.rmdir_all('_docs') or {} -os.rmdir_all('docs') or {} -os.rmdir_all('vdocs') or {} +os.mkdir_all('_docs') or {} +os.mkdir_all('docs') or {} +os.mkdir_all('vdocs') or {} // Generate HTML documentation println('Generating HTML documentation...') @@ -42,13 +42,12 @@ os.chdir(abs_dir_of_script) or { // Generate Markdown documentation println('Generating Markdown documentation...') -os.rmdir_all('vdocs') or {} // if os.system('v doc -m -no-color -f md -o ../vdocs/v/') != 0 { // panic('Failed to generate V markdown documentation') // } -if os.system('v doc -m -no-color -f md -o vdocs/herolib/') != 0 { +if os.system('v doc -m -no-color -f md -o vdocs/') != 0 { panic('Failed to generate Hero markdown documentation') } diff --git a/install_hero.sh b/install_hero.sh index 614434be..bd73be7a 100755 --- a/install_hero.sh +++ b/install_hero.sh @@ -5,18 +5,36 @@ set -e os_name="$(uname -s)" arch_name="$(uname -m)" + +# Base URL for GitHub releases +base_url="https://github.com/freeflowuniverse/herolib/releases/download/v1.0.1" + # Select the URL based on the platform if [[ "$os_name" == "Linux" && "$arch_name" == "x86_64" ]]; then - url="https://f003.backblazeb2.com/file/threefold/linux-i64/hero" + url="$base_url/hero-x86_64-unknown-linux-musl" +elif [[ "$os_name" == "Linux" && "$arch_name" == "aarch64" ]]; then + url="$base_url/hero-aarch64-unknown-linux-musl" elif [[ "$os_name" == "Darwin" && "$arch_name" == "arm64" ]]; then - url="https://f003.backblazeb2.com/file/threefold/macos-arm64/hero" -# elif [[ "$os_name" == "Darwin" && "$arch_name" == "x86_64" ]]; then -# url="https://f003.backblazeb2.com/file/threefold/macos-i64/hero" + url="$base_url/hero-aarch64-apple-darwin" +elif [[ "$os_name" == "Darwin" && "$arch_name" == "x86_64" ]]; then + url="$base_url/hero-x86_64-apple-darwin" else - echo "Unsupported platform." + echo "Unsupported platform: $os_name $arch_name" exit 1 fi +# # Select the URL based on the platform +# if [[ "$os_name" == "Linux" && "$arch_name" == "x86_64" ]]; then +# url="https://f003.backblazeb2.com/file/threefold/linux-i64/hero" +# elif [[ "$os_name" == "Darwin" && "$arch_name" == "arm64" ]]; then +# url="https://f003.backblazeb2.com/file/threefold/macos-arm64/hero" +# # elif [[ "$os_name" == "Darwin" && "$arch_name" == "x86_64" ]]; then +# # url="https://f003.backblazeb2.com/file/threefold/macos-i64/hero" +# else +# echo "Unsupported platform." +# exit 1 +# fi + # Check for existing hero installations existing_hero=$(which hero 2>/dev/null || true) if [ ! -z "$existing_hero" ]; then diff --git a/vdocs/arrays.md b/vdocs/arrays.md new file mode 100644 index 00000000..069bc436 --- /dev/null +++ b/vdocs/arrays.md @@ -0,0 +1,452 @@ +# module arrays + + +## Contents +- [append](#append) +- [binary_search](#binary_search) +- [carray_to_varray](#carray_to_varray) +- [chunk](#chunk) +- [chunk_while](#chunk_while) +- [concat](#concat) +- [copy](#copy) +- [distinct](#distinct) +- [each](#each) +- [each_indexed](#each_indexed) +- [filter_indexed](#filter_indexed) +- [find_first](#find_first) +- [find_last](#find_last) +- [flat_map](#flat_map) +- [flat_map_indexed](#flat_map_indexed) +- [flatten](#flatten) +- [fold](#fold) +- [fold_indexed](#fold_indexed) +- [group](#group) +- [group_by](#group_by) +- [idx_max](#idx_max) +- [idx_min](#idx_min) +- [index_of_first](#index_of_first) +- [index_of_last](#index_of_last) +- [join_to_string](#join_to_string) +- [lower_bound](#lower_bound) +- [map_indexed](#map_indexed) +- [map_of_counts](#map_of_counts) +- [map_of_indexes](#map_of_indexes) +- [max](#max) +- [merge](#merge) +- [min](#min) +- [partition](#partition) +- [reduce](#reduce) +- [reduce_indexed](#reduce_indexed) +- [rotate_left](#rotate_left) +- [rotate_right](#rotate_right) +- [sum](#sum) +- [uniq](#uniq) +- [uniq_all_repeated](#uniq_all_repeated) +- [uniq_only](#uniq_only) +- [uniq_only_repeated](#uniq_only_repeated) +- [upper_bound](#upper_bound) +- [window](#window) +- [WindowAttribute](#WindowAttribute) + +## append +Example +```v + +arrays.append([1, 3, 5, 7], [2, 4, 6, 8]) // => [1, 3, 5, 7, 2, 4, 6, 8] + +``` + +[[Return to contents]](#Contents) + +## binary_search +Example +```v + +arrays.binary_search([1, 2, 3, 4], 4)! // => 3 + +``` + +[[Return to contents]](#Contents) + +## carray_to_varray +[[Return to contents]](#Contents) + +## chunk +Example +```v + +arrays.chunk([1, 2, 3, 4, 5, 6, 7, 8, 9], 2)) // => [[1, 2], [3, 4], [5, 6], [7, 8], [9]] + +``` + +[[Return to contents]](#Contents) + +## chunk_while +Examples +```v + +assert arrays.chunk_while([0,9,2,2,3,2,7,5,9,5],fn(x int,y int)bool{return x<=y})==[[0,9],[2,2,3],[2,7],[5,9],[5]] + +assert arrays.chunk_while('aaaabbbcca'.runes(),fn(x rune,y rune)bool{return x==y})==[[`a`,`a`,`a`,`a`],[`b`,`b`,`b`],[`c`,`c`],[`a`]] + +assert arrays.chunk_while('aaaabbbcca'.runes(),fn(x rune,y rune)bool{return x==y}).map({it[0]:it.len})==[{`a`:4},{`b`:3},{`c`:2},{`a`:1}] + +``` + +[[Return to contents]](#Contents) + +## concat +Examples +```v + +arrays.concat([1, 2, 3], 4, 5, 6) == [1, 2, 3, 4, 5, 6] // => true + +arrays.concat([1, 2, 3], ...[4, 5, 6]) == [1, 2, 3, 4, 5, 6] // => true + +arr << [4, 5, 6] // does what you need if arr is mutable + +``` + +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## distinct +Example +```v + +assert arrays.distinct( [5, 5, 1, 5, 2, 1, 1, 9] ) == [1, 2, 5, 9] + +``` + +[[Return to contents]](#Contents) + +## each +[[Return to contents]](#Contents) + +## each_indexed +[[Return to contents]](#Contents) + +## filter_indexed +[[Return to contents]](#Contents) + +## find_first +Example +```v + +arrays.find_first([1, 2, 3, 4, 5], fn (i int) bool { return i == 3 })? // => 3 + +``` + +[[Return to contents]](#Contents) + +## find_last +Example +```v + +arrays.find_last([1, 2, 3, 4, 5], fn (i int) bool { return i == 3})? // => 3 + +``` + +[[Return to contents]](#Contents) + +## flat_map +[[Return to contents]](#Contents) + +## flat_map_indexed +[[Return to contents]](#Contents) + +## flatten +Example +```v + +arrays.flatten[int]([[1, 2, 3], [4, 5]]) // => [1, 2, 3, 4, 5] + +``` + +[[Return to contents]](#Contents) + +## fold +Example +```v + +// Sum the length of each string in an array +a := ['Hi', 'all'] +r := arrays.fold[string, int](a, 0, + fn (r int, t string) int { return r + t.len }) +assert r == 5 + +``` + +[[Return to contents]](#Contents) + +## fold_indexed +[[Return to contents]](#Contents) + +## group +Example +```v + +arrays.group[int]([1, 2, 3], [4, 5, 6]) // => [[1, 4], [2, 5], [3, 6]] + +``` + +[[Return to contents]](#Contents) + +## group_by +Example +```v + +arrays.group_by[int, string](['H', 'el', 'lo'], fn (v string) int { return v.len }) // => {1: ['H'], 2: ['el', 'lo']} + +``` + +[[Return to contents]](#Contents) + +## idx_max +Example +```v + +arrays.idx_max([1, 2, 3, 0, 9])! // => 4 + +``` + +[[Return to contents]](#Contents) + +## idx_min +Example +```v + +arrays.idx_min([1, 2, 3, 0, 9])! // => 3 + +``` + +[[Return to contents]](#Contents) + +## index_of_first +Example +```v + +arrays.index_of_first([4,5,0,7,0,9], fn(idx int, x int) bool { return x == 0 }) == 2 + +``` + +[[Return to contents]](#Contents) + +## index_of_last +Example +```v + +arrays.index_of_last([4,5,0,7,0,9], fn(idx int, x int) bool { return x == 0 }) == 4 + +``` + +[[Return to contents]](#Contents) + +## join_to_string +[[Return to contents]](#Contents) + +## lower_bound +Example +```v + +arrays.lower_bound([2, 4, 6, 8], 3)! // => 4 + +``` + +[[Return to contents]](#Contents) + +## map_indexed +[[Return to contents]](#Contents) + +## map_of_counts +Example +```v + +arrays.map_of_counts([1,2,3,4,4,2,1,4,4]) == {1: 2, 2: 2, 3: 1, 4: 4} + +``` + +[[Return to contents]](#Contents) + +## map_of_indexes +Example +```v + +arrays.map_of_indexes([1,2,3,4,4,2,1,4,4,999]) == {1: [0, 6], 2: [1, 5], 3: [2], 4: [3, 4, 7, 8], 999: [9]} + +``` + +[[Return to contents]](#Contents) + +## max +Example +```v + +arrays.max([1, 2, 3, 0, 9])! // => 9 + +``` + +[[Return to contents]](#Contents) + +## merge +Example +```v + +arrays.merge([1, 3, 5, 7], [2, 4, 6, 8]) // => [1, 2, 3, 4, 5, 6, 7, 8] + +``` + +[[Return to contents]](#Contents) + +## min +Example +```v + +arrays.min([1, 2, 3, 0, 9])! // => 0 + +``` + +[[Return to contents]](#Contents) + +## partition +[[Return to contents]](#Contents) + +## reduce +Example +```v + +arrays.reduce([1, 2, 3, 4, 5], fn (t1 int, t2 int) int { return t1 * t2 })! // => 120 + +``` + +[[Return to contents]](#Contents) + +## reduce_indexed +[[Return to contents]](#Contents) + +## rotate_left +Example +```v + +mut x := [1,2,3,4,5,6] +arrays.rotate_left(mut x, 2) +println(x) // [3, 4, 5, 6, 1, 2] + +``` + +[[Return to contents]](#Contents) + +## rotate_right +Example +```v + +mut x := [1,2,3,4,5,6] +arrays.rotate_right(mut x, 2) +println(x) // [5, 6, 1, 2, 3, 4] + +``` + +[[Return to contents]](#Contents) + +## sum +Example +```v + +arrays.sum([1, 2, 3, 4, 5])! // => 15 + +``` + +[[Return to contents]](#Contents) + +## uniq +Examples +```v + +assert arrays.uniq( []int{} ) == [] + +assert arrays.uniq( [1, 1] ) == [1] + +assert arrays.uniq( [2, 1] ) == [2, 1] + +assert arrays.uniq( [5, 5, 1, 5, 2, 1, 1, 9] ) == [5, 1, 5, 2, 1, 9] + +``` + +[[Return to contents]](#Contents) + +## uniq_all_repeated +Examples +```v + +assert arrays.uniq_all_repeated( []int{} ) == [] + +assert arrays.uniq_all_repeated( [1, 5] ) == [] + +assert arrays.uniq_all_repeated( [5, 5] ) == [5,5] + +assert arrays.uniq_all_repeated( [5, 5, 1, 5, 2, 1, 1, 9] ) == [5, 5, 1, 1] + +``` + +[[Return to contents]](#Contents) + +## uniq_only +Examples +```v + +assert arrays.uniq_only( []int{} ) == [] + +assert arrays.uniq_only( [1, 1] ) == [] + +assert arrays.uniq_only( [2, 1] ) == [2, 1] + +assert arrays.uniq_only( [1, 5, 5, 1, 5, 2, 1, 1, 9] ) == [1, 1, 5, 2, 9] + +``` + +[[Return to contents]](#Contents) + +## uniq_only_repeated +Examples +```v + +assert arrays.uniq_only_repeated( []int{} ) == [] + +assert arrays.uniq_only_repeated( [1, 5] ) == [] + +assert arrays.uniq_only_repeated( [5, 5] ) == [5] + +assert arrays.uniq_only_repeated( [5, 5, 1, 5, 2, 1, 1, 9] ) == [5, 1] + +``` + +[[Return to contents]](#Contents) + +## upper_bound +Example +```v + +arrays.upper_bound([2, 4, 6, 8], 3)! // => 2 + +``` + +[[Return to contents]](#Contents) + +## window +Examples +```v + +arrays.window([1, 2, 3, 4], size: 2) // => [[1, 2], [2, 3], [3, 4]] + +arrays.window([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], size: 3, step: 2) // => [[1, 2, 3], [3, 4, 5], [5, 6, 7], [7, 8, 9]] + +``` + +[[Return to contents]](#Contents) + +## WindowAttribute +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/arrays.parallel.md b/vdocs/arrays.parallel.md new file mode 100644 index 00000000..cf4f6b7a --- /dev/null +++ b/vdocs/arrays.parallel.md @@ -0,0 +1,32 @@ +# module arrays.parallel + + +## Contents +- [amap](#amap) +- [run](#run) +- [Params](#Params) + +## amap +Example +```v + +squares := parallel.amap([1, 2, 3, 4, 5], 2, fn (i) { return i * i }) + +``` + +[[Return to contents]](#Contents) + +## run +Example +```v + +parallel.run([1, 2, 3, 4, 5], 2, fn (i) { println(i) }) + +``` + +[[Return to contents]](#Contents) + +## Params +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/benchmark.md b/vdocs/benchmark.md new file mode 100644 index 00000000..6a3fb366 --- /dev/null +++ b/vdocs/benchmark.md @@ -0,0 +1,124 @@ +# module benchmark + + +## Contents +- [Constants](#Constants) +- [new_benchmark](#new_benchmark) +- [new_benchmark_no_cstep](#new_benchmark_no_cstep) +- [new_benchmark_pointer](#new_benchmark_pointer) +- [start](#start) +- [Benchmark](#Benchmark) + - [set_total_expected_steps](#set_total_expected_steps) + - [stop](#stop) + - [step](#step) + - [step_restart](#step_restart) + - [fail](#fail) + - [ok](#ok) + - [skip](#skip) + - [fail_many](#fail_many) + - [ok_many](#ok_many) + - [neither_fail_nor_ok](#neither_fail_nor_ok) + - [measure](#measure) + - [record_measure](#record_measure) + - [step_message_with_label_and_duration](#step_message_with_label_and_duration) + - [step_message_with_label](#step_message_with_label) + - [step_message](#step_message) + - [step_message_ok](#step_message_ok) + - [step_message_fail](#step_message_fail) + - [step_message_skip](#step_message_skip) + - [total_message](#total_message) + - [all_recorded_measures](#all_recorded_measures) + - [total_duration](#total_duration) +- [MessageOptions](#MessageOptions) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new_benchmark +[[Return to contents]](#Contents) + +## new_benchmark_no_cstep +[[Return to contents]](#Contents) + +## new_benchmark_pointer +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +## Benchmark +[[Return to contents]](#Contents) + +## set_total_expected_steps +[[Return to contents]](#Contents) + +## stop +[[Return to contents]](#Contents) + +## step +[[Return to contents]](#Contents) + +## step_restart +[[Return to contents]](#Contents) + +## fail +[[Return to contents]](#Contents) + +## ok +[[Return to contents]](#Contents) + +## skip +[[Return to contents]](#Contents) + +## fail_many +[[Return to contents]](#Contents) + +## ok_many +[[Return to contents]](#Contents) + +## neither_fail_nor_ok +[[Return to contents]](#Contents) + +## measure +[[Return to contents]](#Contents) + +## record_measure +[[Return to contents]](#Contents) + +## step_message_with_label_and_duration +[[Return to contents]](#Contents) + +## step_message_with_label +[[Return to contents]](#Contents) + +## step_message +[[Return to contents]](#Contents) + +## step_message_ok +[[Return to contents]](#Contents) + +## step_message_fail +[[Return to contents]](#Contents) + +## step_message_skip +[[Return to contents]](#Contents) + +## total_message +[[Return to contents]](#Contents) + +## all_recorded_measures +[[Return to contents]](#Contents) + +## total_duration +[[Return to contents]](#Contents) + +## MessageOptions +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/bitfield.md b/vdocs/bitfield.md new file mode 100644 index 00000000..b7203eb3 --- /dev/null +++ b/vdocs/bitfield.md @@ -0,0 +1,201 @@ +# module bitfield + + +## Contents +- [bf_and](#bf_and) +- [bf_not](#bf_not) +- [bf_or](#bf_or) +- [bf_xor](#bf_xor) +- [from_bytes](#from_bytes) +- [from_bytes_lowest_bits_first](#from_bytes_lowest_bits_first) +- [from_str](#from_str) +- [hamming](#hamming) +- [join](#join) +- [new](#new) +- [BitField](#BitField) + - [str](#str) + - [free](#free) + - [get_bit](#get_bit) + - [set_bit](#set_bit) + - [clear_bit](#clear_bit) + - [extract](#extract) + - [insert](#insert) + - [extract_lowest_bits_first](#extract_lowest_bits_first) + - [insert_lowest_bits_first](#insert_lowest_bits_first) + - [set_all](#set_all) + - [clear_all](#clear_all) + - [toggle_bit](#toggle_bit) + - [set_if](#set_if) + - [toggle_bits](#toggle_bits) + - [set_bits](#set_bits) + - [clear_bits](#clear_bits) + - [has](#has) + - [all](#all) + - [get_size](#get_size) + - [clone](#clone) + - [==](#==) + - [pop_count](#pop_count) + - [pos](#pos) + - [slice](#slice) + - [reverse](#reverse) + - [resize](#resize) + - [rotate](#rotate) + - [shift_left](#shift_left) + - [shift_right](#shift_right) + +## bf_and +[[Return to contents]](#Contents) + +## bf_not +[[Return to contents]](#Contents) + +## bf_or +[[Return to contents]](#Contents) + +## bf_xor +[[Return to contents]](#Contents) + +## from_bytes +[[Return to contents]](#Contents) + +## from_bytes_lowest_bits_first +[[Return to contents]](#Contents) + +## from_str +[[Return to contents]](#Contents) + +## hamming +[[Return to contents]](#Contents) + +## join +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## BitField +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## get_bit +[[Return to contents]](#Contents) + +## set_bit +[[Return to contents]](#Contents) + +## clear_bit +[[Return to contents]](#Contents) + +## extract +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## extract_lowest_bits_first +[[Return to contents]](#Contents) + +## insert_lowest_bits_first +[[Return to contents]](#Contents) + +## set_all +[[Return to contents]](#Contents) + +## clear_all +[[Return to contents]](#Contents) + +## toggle_bit +[[Return to contents]](#Contents) + +## set_if +[[Return to contents]](#Contents) + +## toggle_bits +Example +```v + +toggle_bits(1,3,5,7) + +``` + +[[Return to contents]](#Contents) + +## set_bits +Example +```v + +set_bits(1,3,5,7) + +``` + +[[Return to contents]](#Contents) + +## clear_bits +Example +```v + +clear_bits(1,3,5,7) + +``` + +[[Return to contents]](#Contents) + +## has +Example +```v + +has(1,3,5,7) + +``` + +[[Return to contents]](#Contents) + +## all +Example +```v + +all(1,3,5,7) + +``` + +[[Return to contents]](#Contents) + +## get_size +[[Return to contents]](#Contents) + +## clone +[[Return to contents]](#Contents) + +## == +[[Return to contents]](#Contents) + +## pop_count +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +## slice +[[Return to contents]](#Contents) + +## reverse +[[Return to contents]](#Contents) + +## resize +[[Return to contents]](#Contents) + +## rotate +[[Return to contents]](#Contents) + +## shift_left +[[Return to contents]](#Contents) + +## shift_right +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/builtin.md b/vdocs/builtin.md new file mode 100644 index 00000000..4342dc80 --- /dev/null +++ b/vdocs/builtin.md @@ -0,0 +1,2572 @@ +# module builtin + + +## Contents +- [Constants](#Constants) +- [C.android_print](#C.android_print) +- [arguments](#arguments) +- [at_exit](#at_exit) +- [c_error_number_str](#c_error_number_str) +- [compare_strings](#compare_strings) +- [copy](#copy) +- [cstring_to_vstring](#cstring_to_vstring) +- [eprint](#eprint) +- [eprintln](#eprintln) +- [error](#error) +- [error_with_code](#error_with_code) +- [exit](#exit) +- [f32_abs](#f32_abs) +- [f32_max](#f32_max) +- [f32_min](#f32_min) +- [f64_abs](#f64_abs) +- [f64_max](#f64_max) +- [f64_min](#f64_min) +- [flush_stderr](#flush_stderr) +- [flush_stdout](#flush_stdout) +- [free](#free) +- [gc_check_leaks](#gc_check_leaks) +- [gc_collect](#gc_collect) +- [gc_disable](#gc_disable) +- [gc_enable](#gc_enable) +- [gc_get_warn_proc](#gc_get_warn_proc) +- [gc_heap_usage](#gc_heap_usage) +- [gc_is_enabled](#gc_is_enabled) +- [gc_memory_use](#gc_memory_use) +- [gc_set_warn_proc](#gc_set_warn_proc) +- [get_str_intp_u32_format](#get_str_intp_u32_format) +- [get_str_intp_u64_format](#get_str_intp_u64_format) +- [input_character](#input_character) +- [int_max](#int_max) +- [int_min](#int_min) +- [isnil](#isnil) +- [malloc](#malloc) +- [malloc_noscan](#malloc_noscan) +- [malloc_uncollectable](#malloc_uncollectable) +- [memdup](#memdup) +- [memdup_noscan](#memdup_noscan) +- [memdup_uncollectable](#memdup_uncollectable) +- [panic](#panic) +- [panic_error_number](#panic_error_number) +- [panic_lasterr](#panic_lasterr) +- [panic_n](#panic_n) +- [panic_n2](#panic_n2) +- [panic_option_not_set](#panic_option_not_set) +- [panic_result_not_set](#panic_result_not_set) +- [print](#print) +- [print_backtrace](#print_backtrace) +- [print_backtrace_skipping_top_frames](#print_backtrace_skipping_top_frames) +- [print_character](#print_character) +- [println](#println) +- [proc_pidpath](#proc_pidpath) +- [ptr_str](#ptr_str) +- [realloc_data](#realloc_data) +- [str_intp](#str_intp) +- [str_intp_g32](#str_intp_g32) +- [str_intp_g64](#str_intp_g64) +- [str_intp_rune](#str_intp_rune) +- [str_intp_sq](#str_intp_sq) +- [str_intp_sub](#str_intp_sub) +- [string_from_wide](#string_from_wide) +- [string_from_wide2](#string_from_wide2) +- [string_to_ansi_not_null_terminated](#string_to_ansi_not_null_terminated) +- [tos](#tos) +- [tos2](#tos2) +- [tos3](#tos3) +- [tos4](#tos4) +- [tos5](#tos5) +- [tos_clone](#tos_clone) +- [unbuffer_stdout](#unbuffer_stdout) +- [utf32_decode_to_buffer](#utf32_decode_to_buffer) +- [utf32_to_str](#utf32_to_str) +- [utf32_to_str_no_malloc](#utf32_to_str_no_malloc) +- [utf8_char_len](#utf8_char_len) +- [utf8_str_visible_length](#utf8_str_visible_length) +- [v_realloc](#v_realloc) +- [vcalloc](#vcalloc) +- [vcalloc_noscan](#vcalloc_noscan) +- [vmemcmp](#vmemcmp) +- [vmemcpy](#vmemcpy) +- [vmemmove](#vmemmove) +- [vmemset](#vmemset) +- [vstrlen](#vstrlen) +- [vstrlen_char](#vstrlen_char) +- [wide_to_ansi](#wide_to_ansi) +- [IError](#IError) + - [free](#free) + - [str](#str) +- [C.intptr_t](#C.intptr_t) +- [FnExitCb](#FnExitCb) +- [FnGC_WarnCB](#FnGC_WarnCB) +- [MessageError](#MessageError) + - [str](#str) + - [msg](#msg) + - [code](#code) + - [free](#free) +- [[]rune](#[]rune) + - [string](#string) +- [[]string](#[]string) + - [free](#free) + - [join](#join) + - [join_lines](#join_lines) + - [sort_by_len](#sort_by_len) + - [sort_ignore_case](#sort_ignore_case) + - [str](#str) +- [[]u8](#[]u8) + - [byterune](#byterune) + - [bytestr](#bytestr) + - [hex](#hex) + - [utf8_to_utf32](#utf8_to_utf32) +- [bool](#bool) + - [str](#str) +- [byte](#byte) +- [byteptr](#byteptr) + - [str](#str) + - [vbytes](#vbytes) + - [vstring](#vstring) + - [vstring_literal](#vstring_literal) + - [vstring_literal_with_len](#vstring_literal_with_len) + - [vstring_with_len](#vstring_with_len) +- [chan](#chan) + - [close](#close) + - [try_pop](#try_pop) + - [try_push](#try_push) +- [char](#char) + - [str](#str) + - [vstring](#vstring) + - [vstring_literal](#vstring_literal) + - [vstring_literal_with_len](#vstring_literal_with_len) + - [vstring_with_len](#vstring_with_len) +- [charptr](#charptr) + - [str](#str) + - [vstring](#vstring) + - [vstring_literal](#vstring_literal) + - [vstring_literal_with_len](#vstring_literal_with_len) + - [vstring_with_len](#vstring_with_len) +- [f32](#f32) + - [str](#str) + - [strg](#strg) + - [strsci](#strsci) + - [strlong](#strlong) + - [eq_epsilon](#eq_epsilon) +- [f64](#f64) + - [str](#str) + - [strg](#strg) + - [strsci](#strsci) + - [strlong](#strlong) + - [eq_epsilon](#eq_epsilon) +- [float-literal](#float literal) + - [str](#str) +- [i16](#i16) + - [str](#str) + - [hex](#hex) + - [hex_full](#hex_full) +- [i32](#i32) + - [str](#str) +- [i64](#i64) + - [str](#str) + - [hex](#hex) + - [hex_full](#hex_full) +- [i8](#i8) + - [str](#str) + - [hex](#hex) + - [hex_full](#hex_full) +- [int](#int) + - [hex_full](#hex_full) + - [str](#str) + - [hex](#hex) + - [hex2](#hex2) +- [int-literal](#int literal) + - [str](#str) + - [hex](#hex) + - [hex_full](#hex_full) +- [isize](#isize) + - [str](#str) +- [none](#none) + - [str](#str) +- [rune](#rune) + - [str](#str) + - [repeat](#repeat) + - [bytes](#bytes) + - [length_in_bytes](#length_in_bytes) + - [to_upper](#to_upper) + - [to_lower](#to_lower) + - [to_title](#to_title) +- [u16](#u16) + - [str](#str) + - [hex](#hex) + - [hex_full](#hex_full) +- [u32](#u32) + - [str](#str) + - [hex](#hex) + - [hex_full](#hex_full) +- [u64](#u64) + - [str](#str) + - [hex](#hex) + - [hex_full](#hex_full) +- [u8](#u8) + - [ascii_str](#ascii_str) + - [free](#free) + - [hex](#hex) + - [hex_full](#hex_full) + - [is_alnum](#is_alnum) + - [is_bin_digit](#is_bin_digit) + - [is_capital](#is_capital) + - [is_digit](#is_digit) + - [is_hex_digit](#is_hex_digit) + - [is_letter](#is_letter) + - [is_oct_digit](#is_oct_digit) + - [is_space](#is_space) + - [repeat](#repeat) + - [str](#str) + - [str_escaped](#str_escaped) + - [vbytes](#vbytes) + - [vstring](#vstring) + - [vstring_literal](#vstring_literal) + - [vstring_literal_with_len](#vstring_literal_with_len) + - [vstring_with_len](#vstring_with_len) +- [usize](#usize) + - [str](#str) +- [voidptr](#voidptr) + - [hex_full](#hex_full) + - [str](#str) + - [vbytes](#vbytes) +- [ArrayFlags](#ArrayFlags) +- [AttributeKind](#AttributeKind) +- [ChanState](#ChanState) +- [StrIntpType](#StrIntpType) + - [str](#str) +- [C.DIR](#C.DIR) +- [C.FILE](#C.FILE) +- [C.GC_stack_base](#C.GC_stack_base) +- [C.IError](#C.IError) +- [EnumData](#EnumData) +- [Error](#Error) + - [msg](#msg) + - [code](#code) +- [FieldData](#FieldData) +- [FunctionData](#FunctionData) +- [GCHeapUsage](#GCHeapUsage) +- [MethodParam](#MethodParam) +- [SortedMap](#SortedMap) + - [delete](#delete) + - [keys](#keys) + - [free](#free) + - [print](#print) +- [StrIntpCgenData](#StrIntpCgenData) +- [StrIntpData](#StrIntpData) +- [StrIntpMem](#StrIntpMem) +- [VAssertMetaInfo](#VAssertMetaInfo) + - [free](#free) +- [VAttribute](#VAttribute) +- [VContext](#VContext) +- [VariantData](#VariantData) +- [WrapConfig](#WrapConfig) +- [array](#array) + - [repeat](#repeat) + - [repeat_to_depth](#repeat_to_depth) + - [insert](#insert) + - [prepend](#prepend) + - [delete](#delete) + - [delete_many](#delete_many) + - [clear](#clear) + - [reset](#reset) + - [trim](#trim) + - [drop](#drop) + - [first](#first) + - [last](#last) + - [pop](#pop) + - [delete_last](#delete_last) + - [clone](#clone) + - [clone_to_depth](#clone_to_depth) + - [push_many](#push_many) + - [reverse_in_place](#reverse_in_place) + - [reverse](#reverse) + - [free](#free) + - [filter](#filter) + - [any](#any) + - [count](#count) + - [all](#all) + - [map](#map) + - [sort](#sort) + - [sorted](#sorted) + - [sort_with_compare](#sort_with_compare) + - [sorted_with_compare](#sorted_with_compare) + - [contains](#contains) + - [index](#index) + - [grow_cap](#grow_cap) + - [grow_len](#grow_len) + - [pointers](#pointers) +- [map](#map) + - [move](#move) + - [clear](#clear) + - [reserve](#reserve) + - [delete](#delete) + - [keys](#keys) + - [values](#values) + - [clone](#clone) + - [free](#free) +- [string](#string) + - [after](#after) + - [after_char](#after_char) + - [all_after](#all_after) + - [all_after_first](#all_after_first) + - [all_after_last](#all_after_last) + - [all_before](#all_before) + - [all_before_last](#all_before_last) + - [before](#before) + - [bool](#bool) + - [bytes](#bytes) + - [camel_to_snake](#camel_to_snake) + - [capitalize](#capitalize) + - [clone](#clone) + - [compare](#compare) + - [contains](#contains) + - [contains_any](#contains_any) + - [contains_any_substr](#contains_any_substr) + - [contains_only](#contains_only) + - [contains_u8](#contains_u8) + - [count](#count) + - [ends_with](#ends_with) + - [f32](#f32) + - [f64](#f64) + - [fields](#fields) + - [find_between](#find_between) + - [free](#free) + - [hash](#hash) + - [hex](#hex) + - [i16](#i16) + - [i32](#i32) + - [i64](#i64) + - [i8](#i8) + - [indent_width](#indent_width) + - [index](#index) + - [index_after](#index_after) + - [index_any](#index_any) + - [index_u8](#index_u8) + - [int](#int) + - [is_ascii](#is_ascii) + - [is_bin](#is_bin) + - [is_blank](#is_blank) + - [is_capital](#is_capital) + - [is_hex](#is_hex) + - [is_int](#is_int) + - [is_lower](#is_lower) + - [is_oct](#is_oct) + - [is_pure_ascii](#is_pure_ascii) + - [is_title](#is_title) + - [is_upper](#is_upper) + - [last_index](#last_index) + - [last_index_u8](#last_index_u8) + - [len_utf8](#len_utf8) + - [limit](#limit) + - [match_glob](#match_glob) + - [normalize_tabs](#normalize_tabs) + - [parse_int](#parse_int) + - [parse_uint](#parse_uint) + - [repeat](#repeat) + - [replace](#replace) + - [replace_char](#replace_char) + - [replace_each](#replace_each) + - [replace_once](#replace_once) + - [reverse](#reverse) + - [rsplit](#rsplit) + - [rsplit_any](#rsplit_any) + - [rsplit_nth](#rsplit_nth) + - [rsplit_once](#rsplit_once) + - [runes](#runes) + - [snake_to_camel](#snake_to_camel) + - [split](#split) + - [split_any](#split_any) + - [split_by_space](#split_by_space) + - [split_into_lines](#split_into_lines) + - [split_n](#split_n) + - [split_nth](#split_nth) + - [split_once](#split_once) + - [starts_with](#starts_with) + - [starts_with_capital](#starts_with_capital) + - [str](#str) + - [strip_margin](#strip_margin) + - [strip_margin_custom](#strip_margin_custom) + - [substr](#substr) + - [substr_ni](#substr_ni) + - [substr_unsafe](#substr_unsafe) + - [substr_with_check](#substr_with_check) + - [title](#title) + - [to_lower](#to_lower) + - [to_lower_ascii](#to_lower_ascii) + - [to_upper](#to_upper) + - [to_upper_ascii](#to_upper_ascii) + - [to_wide](#to_wide) + - [trim](#trim) + - [trim_indent](#trim_indent) + - [trim_indexes](#trim_indexes) + - [trim_left](#trim_left) + - [trim_right](#trim_right) + - [trim_space](#trim_space) + - [trim_space_left](#trim_space_left) + - [trim_space_right](#trim_space_right) + - [trim_string_left](#trim_string_left) + - [trim_string_right](#trim_string_right) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [u8](#u8) + - [u8_array](#u8_array) + - [uncapitalize](#uncapitalize) + - [utf32_code](#utf32_code) + - [wrap](#wrap) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## C.android_print +[[Return to contents]](#Contents) + +## arguments +[[Return to contents]](#Contents) + +## at_exit +[[Return to contents]](#Contents) + +## c_error_number_str +[[Return to contents]](#Contents) + +## compare_strings +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## cstring_to_vstring +[[Return to contents]](#Contents) + +## eprint +[[Return to contents]](#Contents) + +## eprintln +[[Return to contents]](#Contents) + +## error +Example +```v + +if ouch { return error('an error occurred') } + +``` + +[[Return to contents]](#Contents) + +## error_with_code +Example +```v + +if ouch { return error_with_code('an error occurred', 1) } + +``` + +[[Return to contents]](#Contents) + +## exit +[[Return to contents]](#Contents) + +## f32_abs +Example +```v + +assert f32_abs(-2.0) == 2.0 + +``` + +[[Return to contents]](#Contents) + +## f32_max +Example +```v + +assert f32_max(2.0,3.0) == 3.0 + +``` + +[[Return to contents]](#Contents) + +## f32_min +Example +```v + +assert f32_min(2.0,3.0) == 2.0 + +``` + +[[Return to contents]](#Contents) + +## f64_abs +Example +```v + +assert f64_abs(-2.0) == f64(2.0) + +``` + +[[Return to contents]](#Contents) + +## f64_max +Example +```v + +assert f64_max(2.0,3.0) == 3.0 + +``` + +[[Return to contents]](#Contents) + +## f64_min +Example +```v + +assert f64_min(2.0,3.0) == 2.0 + +``` + +[[Return to contents]](#Contents) + +## flush_stderr +[[Return to contents]](#Contents) + +## flush_stdout +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## gc_check_leaks +[[Return to contents]](#Contents) + +## gc_collect +[[Return to contents]](#Contents) + +## gc_disable +[[Return to contents]](#Contents) + +## gc_enable +[[Return to contents]](#Contents) + +## gc_get_warn_proc +[[Return to contents]](#Contents) + +## gc_heap_usage +[[Return to contents]](#Contents) + +## gc_is_enabled +[[Return to contents]](#Contents) + +## gc_memory_use +[[Return to contents]](#Contents) + +## gc_set_warn_proc +[[Return to contents]](#Contents) + +## get_str_intp_u32_format +[[Return to contents]](#Contents) + +## get_str_intp_u64_format +[[Return to contents]](#Contents) + +## input_character +[[Return to contents]](#Contents) + +## int_max +Example +```v + +assert int_max(2,3) == 3 + +``` + +[[Return to contents]](#Contents) + +## int_min +Example +```v + +assert int_min(2,3) == 2 + +``` + +[[Return to contents]](#Contents) + +## isnil +[[Return to contents]](#Contents) + +## malloc +[[Return to contents]](#Contents) + +## malloc_noscan +[[Return to contents]](#Contents) + +## malloc_uncollectable +[[Return to contents]](#Contents) + +## memdup +[[Return to contents]](#Contents) + +## memdup_noscan +[[Return to contents]](#Contents) + +## memdup_uncollectable +[[Return to contents]](#Contents) + +## panic +[[Return to contents]](#Contents) + +## panic_error_number +[[Return to contents]](#Contents) + +## panic_lasterr +[[Return to contents]](#Contents) + +## panic_n +[[Return to contents]](#Contents) + +## panic_n2 +[[Return to contents]](#Contents) + +## panic_option_not_set +[[Return to contents]](#Contents) + +## panic_result_not_set +[[Return to contents]](#Contents) + +## print +[[Return to contents]](#Contents) + +## print_backtrace +[[Return to contents]](#Contents) + +## print_backtrace_skipping_top_frames +[[Return to contents]](#Contents) + +## print_character +[[Return to contents]](#Contents) + +## println +[[Return to contents]](#Contents) + +## proc_pidpath +[[Return to contents]](#Contents) + +## ptr_str +[[Return to contents]](#Contents) + +## realloc_data +[[Return to contents]](#Contents) + +## str_intp +[[Return to contents]](#Contents) + +## str_intp_g32 +[[Return to contents]](#Contents) + +## str_intp_g64 +[[Return to contents]](#Contents) + +## str_intp_rune +[[Return to contents]](#Contents) + +## str_intp_sq +[[Return to contents]](#Contents) + +## str_intp_sub +[[Return to contents]](#Contents) + +## string_from_wide +[[Return to contents]](#Contents) + +## string_from_wide2 +[[Return to contents]](#Contents) + +## string_to_ansi_not_null_terminated +[[Return to contents]](#Contents) + +## tos +[[Return to contents]](#Contents) + +## tos2 +[[Return to contents]](#Contents) + +## tos3 +[[Return to contents]](#Contents) + +## tos4 +[[Return to contents]](#Contents) + +## tos5 +[[Return to contents]](#Contents) + +## tos_clone +[[Return to contents]](#Contents) + +## unbuffer_stdout +[[Return to contents]](#Contents) + +## utf32_decode_to_buffer +[[Return to contents]](#Contents) + +## utf32_to_str +[[Return to contents]](#Contents) + +## utf32_to_str_no_malloc +[[Return to contents]](#Contents) + +## utf8_char_len +[[Return to contents]](#Contents) + +## utf8_str_visible_length +[[Return to contents]](#Contents) + +## v_realloc +[[Return to contents]](#Contents) + +## vcalloc +[[Return to contents]](#Contents) + +## vcalloc_noscan +[[Return to contents]](#Contents) + +## vmemcmp +[[Return to contents]](#Contents) + +## vmemcpy +[[Return to contents]](#Contents) + +## vmemmove +[[Return to contents]](#Contents) + +## vmemset +[[Return to contents]](#Contents) + +## vstrlen +[[Return to contents]](#Contents) + +## vstrlen_char +[[Return to contents]](#Contents) + +## wide_to_ansi +[[Return to contents]](#Contents) + +## IError +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## C.intptr_t +[[Return to contents]](#Contents) + +## FnExitCb +[[Return to contents]](#Contents) + +## FnGC_WarnCB +[[Return to contents]](#Contents) + +## MessageError +## str +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## code +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## []rune +## string +[[Return to contents]](#Contents) + +## []string +## free +[[Return to contents]](#Contents) + +## join +Example +```v + +assert ['Hello','V'].join(' ') == 'Hello V' + +``` + +[[Return to contents]](#Contents) + +## join_lines +[[Return to contents]](#Contents) + +## sort_by_len +[[Return to contents]](#Contents) + +## sort_ignore_case +[[Return to contents]](#Contents) + +## str +Example +```v + +['a', 'b', 'c'].str() // => "['a', 'b', 'c']". + +``` + +[[Return to contents]](#Contents) + +## []u8 +## byterune +[[Return to contents]](#Contents) + +## bytestr +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## utf8_to_utf32 +[[Return to contents]](#Contents) + +## bool +## str +Example +```v + +assert (2 > 1).str() == 'true' + +``` + +[[Return to contents]](#Contents) + +## byte +[[Return to contents]](#Contents) + +## byteptr +## str +[[Return to contents]](#Contents) + +## vbytes +[[Return to contents]](#Contents) + +## vstring +[[Return to contents]](#Contents) + +## vstring_literal +[[Return to contents]](#Contents) + +## vstring_literal_with_len +[[Return to contents]](#Contents) + +## vstring_with_len +[[Return to contents]](#Contents) + +## chan +## close +[[Return to contents]](#Contents) + +## try_pop +[[Return to contents]](#Contents) + +## try_push +[[Return to contents]](#Contents) + +## char +## str +[[Return to contents]](#Contents) + +## vstring +[[Return to contents]](#Contents) + +## vstring_literal +[[Return to contents]](#Contents) + +## vstring_literal_with_len +[[Return to contents]](#Contents) + +## vstring_with_len +[[Return to contents]](#Contents) + +## charptr +## str +[[Return to contents]](#Contents) + +## vstring +[[Return to contents]](#Contents) + +## vstring_literal +[[Return to contents]](#Contents) + +## vstring_literal_with_len +[[Return to contents]](#Contents) + +## vstring_with_len +[[Return to contents]](#Contents) + +## f32 +## str +[[Return to contents]](#Contents) + +## strg +[[Return to contents]](#Contents) + +## strsci +Example +```v + +assert f32(1.234).strsci(3) == '1.234e+00' + +``` + +[[Return to contents]](#Contents) + +## strlong +[[Return to contents]](#Contents) + +## eq_epsilon +Example +```v + +assert f32(2.0).eq_epsilon(2.0) + +``` + +[[Return to contents]](#Contents) + +## f64 +## str +[[Return to contents]](#Contents) + +## strg +[[Return to contents]](#Contents) + +## strsci +Example +```v + +assert f64(1.234).strsci(3) == '1.234e+00' + +``` + +[[Return to contents]](#Contents) + +## strlong +Example +```v + +assert f64(1.23456).strlong() == '1.23456' + +``` + +[[Return to contents]](#Contents) + +## eq_epsilon +Example +```v + +assert f64(2.0).eq_epsilon(2.0) + +``` + +[[Return to contents]](#Contents) + +## float literal +## str +[[Return to contents]](#Contents) + +## i16 +## str +Example +```v + +assert i16(-20).str() == '-20' + +``` + +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert i16(2).hex() == '2' + +assert i16(200).hex() == 'c8' + +``` + +[[Return to contents]](#Contents) + +## hex_full +[[Return to contents]](#Contents) + +## i32 +## str +[[Return to contents]](#Contents) + +## i64 +## str +Example +```v + +assert i64(-200000).str() == '-200000' + +``` + +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert i64(2).hex() == '2' + +assert i64(-200).hex() == 'ffffffffffffff38' + +assert i64(2021).hex() == '7e5' + +``` + +[[Return to contents]](#Contents) + +## hex_full +[[Return to contents]](#Contents) + +## i8 +## str +Example +```v + +assert i8(-2).str() == '-2' + +``` + +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert i8(8).hex() == '08' + +assert i8(10).hex() == '0a' + +assert i8(15).hex() == '0f' + +``` + +[[Return to contents]](#Contents) + +## hex_full +[[Return to contents]](#Contents) + +## int +## hex_full +[[Return to contents]](#Contents) + +## str +Example +```v + +assert int(-2020).str() == '-2020' + +``` + +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert int(2).hex() == '2' + +assert int(200).hex() == 'c8' + +``` + +[[Return to contents]](#Contents) + +## hex2 +Examples +```v + +assert int(8).hex2() == '0x8' + +assert int(15).hex2() == '0xf' + +assert int(18).hex2() == '0x12' + +``` + +[[Return to contents]](#Contents) + +## int literal +## str +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## hex_full +[[Return to contents]](#Contents) + +## isize +## str +[[Return to contents]](#Contents) + +## none +## str +[[Return to contents]](#Contents) + +## rune +## str +[[Return to contents]](#Contents) + +## repeat +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## length_in_bytes +[[Return to contents]](#Contents) + +## to_upper +[[Return to contents]](#Contents) + +## to_lower +[[Return to contents]](#Contents) + +## to_title +[[Return to contents]](#Contents) + +## u16 +## str +Example +```v + +assert u16(20).str() == '20' + +``` + +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert u16(2).hex() == '2' + +assert u16(200).hex() == 'c8' + +``` + +[[Return to contents]](#Contents) + +## hex_full +[[Return to contents]](#Contents) + +## u32 +## str +Example +```v + +assert u32(20000).str() == '20000' + +``` + +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert u32(2).hex() == '2' + +assert u32(200).hex() == 'c8' + +``` + +[[Return to contents]](#Contents) + +## hex_full +[[Return to contents]](#Contents) + +## u64 +## str +Example +```v + +assert u64(2000000).str() == '2000000' + +``` + +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert u64(2).hex() == '2' + +assert u64(2000).hex() == '7d0' + +``` + +[[Return to contents]](#Contents) + +## hex_full +Examples +```v + +assert u64(2).hex_full() == '0000000000000002' + +assert u64(255).hex_full() == '00000000000000ff' + +``` + +[[Return to contents]](#Contents) + +## u8 +## ascii_str +Example +```v + +assert u8(97).ascii_str() == 'a' + +``` + +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## hex +Examples +```v + +assert u8(2).hex() == '02' + +assert u8(15).hex() == '0f' + +assert u8(255).hex() == 'ff' + +``` + +[[Return to contents]](#Contents) + +## hex_full +[[Return to contents]](#Contents) + +## is_alnum +Example +```v + +assert u8(`V`).is_alnum() == true + +``` + +[[Return to contents]](#Contents) + +## is_bin_digit +Example +```v + +assert u8(`0`).is_bin_digit() == true + +``` + +[[Return to contents]](#Contents) + +## is_capital +Examples +```v + +assert `H`.is_capital() == true + +assert `h`.is_capital() == false + +``` + +[[Return to contents]](#Contents) + +## is_digit +Example +```v + +assert u8(`9`).is_digit() == true + +``` + +[[Return to contents]](#Contents) + +## is_hex_digit +Example +```v + +assert u8(`F`).is_hex_digit() == true + +``` + +[[Return to contents]](#Contents) + +## is_letter +Example +```v + +assert u8(`V`).is_letter() == true + +``` + +[[Return to contents]](#Contents) + +## is_oct_digit +Example +```v + +assert u8(`7`).is_oct_digit() == true + +``` + +[[Return to contents]](#Contents) + +## is_space +Example +```v + +assert u8(` `).is_space() == true + +``` + +[[Return to contents]](#Contents) + +## repeat +[[Return to contents]](#Contents) + +## str +Example +```v + +assert u8(111).str() == '111' + +``` + +[[Return to contents]](#Contents) + +## str_escaped +Example +```v + +assert u8(0).str_escaped() == r'`\0`' + +``` + +[[Return to contents]](#Contents) + +## vbytes +[[Return to contents]](#Contents) + +## vstring +[[Return to contents]](#Contents) + +## vstring_literal +[[Return to contents]](#Contents) + +## vstring_literal_with_len +[[Return to contents]](#Contents) + +## vstring_with_len +[[Return to contents]](#Contents) + +## usize +## str +[[Return to contents]](#Contents) + +## voidptr +## hex_full +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## vbytes +[[Return to contents]](#Contents) + +## ArrayFlags +[[Return to contents]](#Contents) + +## AttributeKind +[[Return to contents]](#Contents) + +## ChanState +[[Return to contents]](#Contents) + +## StrIntpType +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## C.DIR +[[Return to contents]](#Contents) + +## C.FILE +[[Return to contents]](#Contents) + +## C.GC_stack_base +[[Return to contents]](#Contents) + +## C.IError +[[Return to contents]](#Contents) + +## EnumData +[[Return to contents]](#Contents) + +## Error +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## code +[[Return to contents]](#Contents) + +## FieldData +[[Return to contents]](#Contents) + +## FunctionData +[[Return to contents]](#Contents) + +## GCHeapUsage +[[Return to contents]](#Contents) + +## MethodParam +[[Return to contents]](#Contents) + +## SortedMap +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## keys +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## print +[[Return to contents]](#Contents) + +## StrIntpCgenData +[[Return to contents]](#Contents) + +## StrIntpData +[[Return to contents]](#Contents) + +## StrIntpMem +[[Return to contents]](#Contents) + +## VAssertMetaInfo +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## VAttribute +[[Return to contents]](#Contents) + +## VContext +[[Return to contents]](#Contents) + +## VariantData +[[Return to contents]](#Contents) + +## WrapConfig +[[Return to contents]](#Contents) + +## array +[[Return to contents]](#Contents) + +## repeat +[[Return to contents]](#Contents) + +## repeat_to_depth +[[Return to contents]](#Contents) + +## insert +Example +```v + +mut a := [1, 2, 4] +a.insert(2, 3) // a now is [1, 2, 3, 4] +mut b := [3, 4] +b.insert(0, [1, 2]) // b now is [1, 2, 3, 4] +mut c := [[3, 4]] +c.insert(0, [1, 2]) // c now is [[1, 2], [3, 4]] + +``` + +[[Return to contents]](#Contents) + +## prepend +[[Return to contents]](#Contents) + +## delete +Example +```v + +mut a := ['0', '1', '2', '3', '4', '5'] +a.delete(1) // a is now ['0', '2', '3', '4', '5'] + +``` + +[[Return to contents]](#Contents) + +## delete_many +Example +```v + +mut a := [1, 2, 3, 4, 5, 6, 7, 8, 9] +b := a[..9] // creates a `slice` of `a`, not a clone +a.delete_many(4, 3) // replaces `a` with a modified clone +dump(a) // a: [1, 2, 3, 4, 8, 9] // `a` is now different +dump(b) // b: [1, 2, 3, 4, 5, 6, 7, 8, 9] // `b` is still the same + +``` + +[[Return to contents]](#Contents) + +## clear +Example +```v + +a.clear() // `a.len` is now 0 + +``` + +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## trim +Example +```v + +a.trim(3) // `a.len` is now <= 3 + +``` + +[[Return to contents]](#Contents) + +## drop +Example +```v + +mut a := [1,2] +a << 3 +a.drop(2) +assert a == [3] +assert a.cap > a.len + +``` + +[[Return to contents]](#Contents) + +## first +[[Return to contents]](#Contents) + +## last +[[Return to contents]](#Contents) + +## pop +Example +```v + +mut a := [1, 2, 3, 4, 5, 6, 7, 8, 9] +b := a[..9] // creates a "view" into the same memory +c := a.pop() // c == 9 +a[1] = 5 +dump(a) // a: [1, 5, 3, 4, 5, 6, 7, 8] +dump(b) // b: [1, 5, 3, 4, 5, 6, 7, 8, 9] + +``` + +[[Return to contents]](#Contents) + +## delete_last +[[Return to contents]](#Contents) + +## clone +[[Return to contents]](#Contents) + +## clone_to_depth +[[Return to contents]](#Contents) + +## push_many +[[Return to contents]](#Contents) + +## reverse_in_place +[[Return to contents]](#Contents) + +## reverse +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## filter +Examples +```v + +array.filter(it < 5) // create an array of elements less than 5 + +array.filter(it % 2 == 1) // create an array of only odd elements + +array.filter(it.name[0] == `A`) // create an array of elements whose `name` field starts with 'A' + +``` + +[[Return to contents]](#Contents) + +## any +Examples +```v + +array.any(it % 2 == 1) // will return true if any element is odd + +array.any(it.name == 'Bob') // will yield `true` if any element has `.name == 'Bob'` + +``` + +[[Return to contents]](#Contents) + +## count +Example +```v + +array.count(it % 2 == 1) // will return how many elements are odd + +``` + +[[Return to contents]](#Contents) + +## all +Example +```v + +array.all(it % 2 == 1) // will return true if every element is odd + +``` + +[[Return to contents]](#Contents) + +## map +Example +```v + +words := ['hello', 'world'] +r1 := words.map(it.to_upper()) +assert r1 == ['HELLO', 'WORLD'] + +// map can also accept anonymous functions +r2 := words.map(fn (w string) string { + return w.to_upper() +}) +assert r2 == ['HELLO', 'WORLD'] + +``` + +[[Return to contents]](#Contents) + +## sort +Examples +```v + +array.sort() // will sort the array in ascending order + +array.sort(b < a) // will sort the array in descending order + +array.sort(b.name < a.name) // will sort descending by the .name field + +``` + +[[Return to contents]](#Contents) + +## sorted +Examples +```v + +assert [9,1,6,3,9].sorted() == [1,3,6,9,9] + +assert [9,1,6,3,9].sorted(b < a) == [9,9,6,3,1] + +``` + +[[Return to contents]](#Contents) + +## sort_with_compare +Example +```v + +fn main() { + mut a := ['hi', '1', '5', '3'] + a.sort_with_compare(fn (a &string, b &string) int { + if a < b { + return -1 + } + if a > b { + return 1 + } + return 0 + }) + assert a == ['1', '3', '5', 'hi'] +} + +``` + +[[Return to contents]](#Contents) + +## sorted_with_compare +[[Return to contents]](#Contents) + +## contains +Example +```v + +[1, 2, 3].contains(4) == false + +``` + +[[Return to contents]](#Contents) + +## index +[[Return to contents]](#Contents) + +## grow_cap +[[Return to contents]](#Contents) + +## grow_len +[[Return to contents]](#Contents) + +## pointers +[[Return to contents]](#Contents) + +## map +[[Return to contents]](#Contents) + +## move +[[Return to contents]](#Contents) + +## clear +Example +```v + +a.clear() // `a.len` and `a.key_values.len` is now 0 + +``` + +[[Return to contents]](#Contents) + +## reserve +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## keys +[[Return to contents]](#Contents) + +## values +[[Return to contents]](#Contents) + +## clone +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## string +[[Return to contents]](#Contents) + +## after +Examples +```v + +assert '23:34:45.234'.after(':') == '45.234' + +assert 'abcd'.after('z') == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## after_char +Examples +```v + +assert '23:34:45.234'.after_char(`:`) == '34:45.234' + +assert 'abcd'.after_char(`:`) == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## all_after +Examples +```v + +assert '23:34:45.234'.all_after('.') == '234' + +assert 'abcd'.all_after('z') == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## all_after_first +Examples +```v + +assert '23:34:45.234'.all_after_first(':') == '34:45.234' + +assert 'abcd'.all_after_first('z') == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## all_after_last +Examples +```v + +assert '23:34:45.234'.all_after_last(':') == '45.234' + +assert 'abcd'.all_after_last('z') == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## all_before +Examples +```v + +assert '23:34:45.234'.all_before('.') == '23:34:45' + +assert 'abcd'.all_before('.') == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## all_before_last +Examples +```v + +assert '23:34:45.234'.all_before_last(':') == '23:34' + +assert 'abcd'.all_before_last('.') == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## before +Examples +```v + +assert '23:34:45.234'.before('.') == '23:34:45' + +assert 'abcd'.before('.') == 'abcd' + +``` + +[[Return to contents]](#Contents) + +## bool +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## camel_to_snake +Examples +```v + +assert 'Abcd'.camel_to_snake() == 'abcd' + +assert 'aaBB'.camel_to_snake() == 'aa_bb' + +assert 'BBaa'.camel_to_snake() == 'b_baa' + +assert 'aa_BB'.camel_to_snake() == 'aa_bb' + +``` + +[[Return to contents]](#Contents) + +## capitalize +Example +```v + +assert 'hello'.capitalize() == 'Hello' + +``` + +[[Return to contents]](#Contents) + +## clone +[[Return to contents]](#Contents) + +## compare +[[Return to contents]](#Contents) + +## contains +[[Return to contents]](#Contents) + +## contains_any +[[Return to contents]](#Contents) + +## contains_any_substr +[[Return to contents]](#Contents) + +## contains_only +[[Return to contents]](#Contents) + +## contains_u8 +[[Return to contents]](#Contents) + +## count +[[Return to contents]](#Contents) + +## ends_with +[[Return to contents]](#Contents) + +## f32 +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## fields +Examples +```v + +assert '\t\tv = v'.fields() == ['v', '=', 'v'] + +assert ' sss ssss'.fields() == ['sss', 'ssss'] + +``` + +[[Return to contents]](#Contents) + +## find_between +Example +```v + +assert 'hey [man] how you doin'.find_between('[', ']') == 'man' + +``` + +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## hash +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## i16 +[[Return to contents]](#Contents) + +## i32 +[[Return to contents]](#Contents) + +## i64 +[[Return to contents]](#Contents) + +## i8 +[[Return to contents]](#Contents) + +## indent_width +Examples +```v + +assert ' v'.indent_width() == 2 + +assert '\t\tv'.indent_width() == 2 + +``` + +[[Return to contents]](#Contents) + +## index +[[Return to contents]](#Contents) + +## index_after +[[Return to contents]](#Contents) + +## index_any +[[Return to contents]](#Contents) + +## index_u8 +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## is_ascii +[[Return to contents]](#Contents) + +## is_bin +[[Return to contents]](#Contents) + +## is_blank +Examples +```v + +assert ' '.is_blank() + +assert '\t'.is_blank() + +assert 'v'.is_blank() == false + +``` + +[[Return to contents]](#Contents) + +## is_capital +Examples +```v + +assert 'Hello'.is_capital() == true + +assert 'HelloWorld'.is_capital() == false + +``` + +[[Return to contents]](#Contents) + +## is_hex +[[Return to contents]](#Contents) + +## is_int +[[Return to contents]](#Contents) + +## is_lower +Example +```v + +assert 'hello developer'.is_lower() == true + +``` + +[[Return to contents]](#Contents) + +## is_oct +[[Return to contents]](#Contents) + +## is_pure_ascii +[[Return to contents]](#Contents) + +## is_title +Example +```v + +assert 'Hello V Developer'.is_title() == true + +``` + +[[Return to contents]](#Contents) + +## is_upper +Example +```v + +assert 'HELLO V'.is_upper() == true + +``` + +[[Return to contents]](#Contents) + +## last_index +[[Return to contents]](#Contents) + +## last_index_u8 +[[Return to contents]](#Contents) + +## len_utf8 +[[Return to contents]](#Contents) + +## limit +[[Return to contents]](#Contents) + +## match_glob +Examples +```v + +assert 'ABCD'.match_glob('AB*') + +assert 'ABCD'.match_glob('*D') + +assert 'ABCD'.match_glob('*B*') + +assert !'ABCD'.match_glob('AB') + +``` + +[[Return to contents]](#Contents) + +## normalize_tabs +Example +```v + +assert '\t\tpop rax\t; pop rax'.normalize_tabs(2) == ' pop rax ; pop rax' + +``` + +[[Return to contents]](#Contents) + +## parse_int +[[Return to contents]](#Contents) + +## parse_uint +[[Return to contents]](#Contents) + +## repeat +[[Return to contents]](#Contents) + +## replace +[[Return to contents]](#Contents) + +## replace_char +Example +```v + +assert '\tHello!'.replace_char(`\t`,` `,8) == ' Hello!' + +``` + +[[Return to contents]](#Contents) + +## replace_each +Example +```v + +assert 'ABCD'.replace_each(['B','C/','C','D','D','C']) == 'AC/DC' + +``` + +[[Return to contents]](#Contents) + +## replace_once +[[Return to contents]](#Contents) + +## reverse +Example +```v + +assert 'Hello V'.reverse() == 'V olleH' + +``` + +[[Return to contents]](#Contents) + +## rsplit +Examples +```v + +assert 'A B C'.rsplit(' ') == ['C','B','A'] + +assert 'DEF'.rsplit('') == ['F','E','D'] + +``` + +[[Return to contents]](#Contents) + +## rsplit_any +Example +```v + +"first row\nsecond row".rsplit_any(" \n") == ['row', 'second', 'row', 'first'] + +``` + +[[Return to contents]](#Contents) + +## rsplit_nth +[[Return to contents]](#Contents) + +## rsplit_once +Example +```v + +path, ext := 'file.ts.dts'.rsplit_once('.')? +assert path == 'file.ts' +assert ext == 'dts' + +``` + +[[Return to contents]](#Contents) + +## runes +[[Return to contents]](#Contents) + +## snake_to_camel +Examples +```v + +assert 'abcd'.snake_to_camel() == 'Abcd' + +assert 'ab_cd'.snake_to_camel() == 'AbCd' + +assert '_abcd'.snake_to_camel() == 'Abcd' + +assert '_abcd_'.snake_to_camel() == 'Abcd' + +``` + +[[Return to contents]](#Contents) + +## split +Examples +```v + +assert 'A B C'.split(' ') == ['A','B','C'] + +assert 'DEF'.split('') == ['D','E','F'] + +``` + +[[Return to contents]](#Contents) + +## split_any +Example +```v + +"first row\nsecond row".split_any(" \n") == ['first', 'row', 'second', 'row'] + +``` + +[[Return to contents]](#Contents) + +## split_by_space +[[Return to contents]](#Contents) + +## split_into_lines +[[Return to contents]](#Contents) + +## split_n +[[Return to contents]](#Contents) + +## split_nth +[[Return to contents]](#Contents) + +## split_once +Example +```v + +path, ext := 'file.ts.dts'.split_once('.')? +assert path == 'file' +assert ext == 'ts.dts' + +``` + +[[Return to contents]](#Contents) + +## starts_with +[[Return to contents]](#Contents) + +## starts_with_capital +Examples +```v + +assert 'Hello'.starts_with_capital() == true + +assert 'Hello. World.'.starts_with_capital() == true + +``` + +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## strip_margin +Example +```v + +st := 'Hello there, + | this is a string, + | Everything before the first | is removed'.strip_margin() + +assert st == 'Hello there, + this is a string, + Everything before the first | is removed' + +``` + +[[Return to contents]](#Contents) + +## strip_margin_custom +[[Return to contents]](#Contents) + +## substr +Example +```v + +assert 'ABCD'.substr(1,3) == 'BC' + +``` + +[[Return to contents]](#Contents) + +## substr_ni +[[Return to contents]](#Contents) + +## substr_unsafe +[[Return to contents]](#Contents) + +## substr_with_check +[[Return to contents]](#Contents) + +## title +Example +```v + +assert 'hello v developer'.title() == 'Hello V Developer' + +``` + +[[Return to contents]](#Contents) + +## to_lower +Example +```v + +assert 'Hello V'.to_lower() == 'hello v' + +``` + +[[Return to contents]](#Contents) + +## to_lower_ascii +[[Return to contents]](#Contents) + +## to_upper +Example +```v + +assert 'Hello V'.to_upper() == 'HELLO V' + +``` + +[[Return to contents]](#Contents) + +## to_upper_ascii +[[Return to contents]](#Contents) + +## to_wide +[[Return to contents]](#Contents) + +## trim +Example +```v + +assert ' ffHello V ffff'.trim(' f') == 'Hello V' + +``` + +[[Return to contents]](#Contents) + +## trim_indent +Example +```v + +st := ' + Hello there, + this is a string, + all the leading indents are removed + and also the first and the last lines if they are blank +'.trim_indent() + +assert st == 'Hello there, +this is a string, +all the leading indents are removed +and also the first and the last lines if they are blank' + +``` + +[[Return to contents]](#Contents) + +## trim_indexes +Example +```v + +left, right := '-hi-'.trim_indexes('-') + +``` + +[[Return to contents]](#Contents) + +## trim_left +Example +```v + +assert 'd Hello V developer'.trim_left(' d') == 'Hello V developer' + +``` + +[[Return to contents]](#Contents) + +## trim_right +Example +```v + +assert ' Hello V d'.trim_right(' d') == ' Hello V' + +``` + +[[Return to contents]](#Contents) + +## trim_space +Example +```v + +assert ' Hello V '.trim_space() == 'Hello V' + +``` + +[[Return to contents]](#Contents) + +## trim_space_left +Example +```v + +assert ' Hello V '.trim_space_left() == 'Hello V ' + +``` + +[[Return to contents]](#Contents) + +## trim_space_right +Example +```v + +assert ' Hello V '.trim_space_right() == ' Hello V' + +``` + +[[Return to contents]](#Contents) + +## trim_string_left +Example +```v + +assert 'WorldHello V'.trim_string_left('World') == 'Hello V' + +``` + +[[Return to contents]](#Contents) + +## trim_string_right +Example +```v + +assert 'Hello VWorld'.trim_string_right('World') == 'Hello V' + +``` + +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u8_array +[[Return to contents]](#Contents) + +## uncapitalize +Example +```v + +assert 'Hello, Bob!'.uncapitalize() == 'hello, Bob!' + +``` + +[[Return to contents]](#Contents) + +## utf32_code +[[Return to contents]](#Contents) + +## wrap +Example +```v + +`assert 'Hello, my name is Carl and I am a delivery'.wrap(width: 20) == 'Hello, my name is\nCarl and I am a\ndelivery'` + +``` + +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/builtin.wchar.md b/vdocs/builtin.wchar.md new file mode 100644 index 00000000..d89aa3fa --- /dev/null +++ b/vdocs/builtin.wchar.md @@ -0,0 +1,61 @@ +# module builtin.wchar + + +## Contents +- [Constants](#Constants) +- [from_rune](#from_rune) +- [from_string](#from_string) +- [length_in_bytes](#length_in_bytes) +- [length_in_characters](#length_in_characters) +- [to_string](#to_string) +- [to_string2](#to_string2) +- [Character](#Character) + - [str](#str) + - [==](#==) + - [to_rune](#to_rune) +- [C.wchar_t](#C.wchar_t) + +## Constants +[[Return to contents]](#Contents) + +## from_rune +[[Return to contents]](#Contents) + +## from_string +[[Return to contents]](#Contents) + +## length_in_bytes +[[Return to contents]](#Contents) + +## length_in_characters +Example +```v + +assert unsafe { wchar.length_in_characters(wchar.from_string('abc')) } == 3 + +``` + +[[Return to contents]](#Contents) + +## to_string +[[Return to contents]](#Contents) + +## to_string2 +[[Return to contents]](#Contents) + +## Character +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## == +[[Return to contents]](#Contents) + +## to_rune +[[Return to contents]](#Contents) + +## C.wchar_t +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/cli.md b/vdocs/cli.md new file mode 100644 index 00000000..7a2d46d4 --- /dev/null +++ b/vdocs/cli.md @@ -0,0 +1,162 @@ +# module cli + + +## Contents +- [print_help_for_command](#print_help_for_command) +- [print_manpage_for_command](#print_manpage_for_command) +- [FnCommandCallback](#FnCommandCallback) + - [str](#str) +- [[]Flag](#[]Flag) + - [get_all_found](#get_all_found) + - [get_bool](#get_bool) + - [get_int](#get_int) + - [get_ints](#get_ints) + - [get_float](#get_float) + - [get_floats](#get_floats) + - [get_string](#get_string) + - [get_strings](#get_strings) +- [FlagType](#FlagType) +- [Command](#Command) + - [add_command](#add_command) + - [add_commands](#add_commands) + - [add_flag](#add_flag) + - [add_flags](#add_flags) + - [execute_help](#execute_help) + - [execute_man](#execute_man) + - [full_name](#full_name) + - [help_message](#help_message) + - [is_root](#is_root) + - [manpage](#manpage) + - [parse](#parse) + - [root](#root) + - [setup](#setup) + - [str](#str) + - [version](#version) +- [CommandFlag](#CommandFlag) +- [Flag](#Flag) + - [get_bool](#get_bool) + - [get_int](#get_int) + - [get_ints](#get_ints) + - [get_float](#get_float) + - [get_floats](#get_floats) + - [get_string](#get_string) + - [get_strings](#get_strings) + - [parse](#parse) + +## print_help_for_command +[[Return to contents]](#Contents) + +## print_manpage_for_command +[[Return to contents]](#Contents) + +## FnCommandCallback +## str +[[Return to contents]](#Contents) + +## []Flag +## get_all_found +[[Return to contents]](#Contents) + +## get_bool +[[Return to contents]](#Contents) + +## get_int +[[Return to contents]](#Contents) + +## get_ints +[[Return to contents]](#Contents) + +## get_float +[[Return to contents]](#Contents) + +## get_floats +[[Return to contents]](#Contents) + +## get_string +[[Return to contents]](#Contents) + +## get_strings +[[Return to contents]](#Contents) + +## FlagType +[[Return to contents]](#Contents) + +## Command +[[Return to contents]](#Contents) + +## add_command +[[Return to contents]](#Contents) + +## add_commands +[[Return to contents]](#Contents) + +## add_flag +[[Return to contents]](#Contents) + +## add_flags +[[Return to contents]](#Contents) + +## execute_help +[[Return to contents]](#Contents) + +## execute_man +[[Return to contents]](#Contents) + +## full_name +[[Return to contents]](#Contents) + +## help_message +[[Return to contents]](#Contents) + +## is_root +[[Return to contents]](#Contents) + +## manpage +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## root +[[Return to contents]](#Contents) + +## setup +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## version +[[Return to contents]](#Contents) + +## CommandFlag +[[Return to contents]](#Contents) + +## Flag +[[Return to contents]](#Contents) + +## get_bool +[[Return to contents]](#Contents) + +## get_int +[[Return to contents]](#Contents) + +## get_ints +[[Return to contents]](#Contents) + +## get_float +[[Return to contents]](#Contents) + +## get_floats +[[Return to contents]](#Contents) + +## get_string +[[Return to contents]](#Contents) + +## get_strings +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/clipboard.dummy.md b/vdocs/clipboard.dummy.md new file mode 100644 index 00000000..d19866a5 --- /dev/null +++ b/vdocs/clipboard.dummy.md @@ -0,0 +1,42 @@ +# module clipboard.dummy + + +## Contents +- [new_clipboard](#new_clipboard) +- [new_primary](#new_primary) +- [Clipboard](#Clipboard) + - [set_text](#set_text) + - [get_text](#get_text) + - [clear](#clear) + - [free](#free) + - [has_ownership](#has_ownership) + - [check_availability](#check_availability) + +## new_clipboard +[[Return to contents]](#Contents) + +## new_primary +[[Return to contents]](#Contents) + +## Clipboard +[[Return to contents]](#Contents) + +## set_text +[[Return to contents]](#Contents) + +## get_text +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## has_ownership +[[Return to contents]](#Contents) + +## check_availability +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/clipboard.md b/vdocs/clipboard.md new file mode 100644 index 00000000..f1410708 --- /dev/null +++ b/vdocs/clipboard.md @@ -0,0 +1,66 @@ +# module clipboard + + +## Contents +- [new](#new) +- [new_primary](#new_primary) +- [Clipboard](#Clipboard) + - [check_availability](#check_availability) + - [check_ownership](#check_ownership) + - [clear](#clear) + - [clear_all](#clear_all) + - [copy](#copy) + - [destroy](#destroy) + - [free](#free) + - [get_text](#get_text) + - [has_ownership](#has_ownership) + - [is_available](#is_available) + - [paste](#paste) + - [set_text](#set_text) + +## new +[[Return to contents]](#Contents) + +## new_primary +[[Return to contents]](#Contents) + +## Clipboard +[[Return to contents]](#Contents) + +## check_availability +[[Return to contents]](#Contents) + +## check_ownership +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## clear_all +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## get_text +[[Return to contents]](#Contents) + +## has_ownership +[[Return to contents]](#Contents) + +## is_available +[[Return to contents]](#Contents) + +## paste +[[Return to contents]](#Contents) + +## set_text +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/clipboard.x11.md b/vdocs/clipboard.x11.md new file mode 100644 index 00000000..309efea1 --- /dev/null +++ b/vdocs/clipboard.x11.md @@ -0,0 +1,62 @@ +# module clipboard.x11 + + +## Contents +- [new_clipboard](#new_clipboard) +- [new_primary](#new_primary) +- [C.Display](#C.Display) +- [C.XDestroyWindowEvent](#C.XDestroyWindowEvent) +- [C.XSelectionClearEvent](#C.XSelectionClearEvent) +- [C.XSelectionEvent](#C.XSelectionEvent) +- [C.XSelectionRequestEvent](#C.XSelectionRequestEvent) +- [Clipboard](#Clipboard) + - [check_availability](#check_availability) + - [free](#free) + - [clear](#clear) + - [has_ownership](#has_ownership) + - [set_text](#set_text) + - [get_text](#get_text) + +## new_clipboard +[[Return to contents]](#Contents) + +## new_primary +[[Return to contents]](#Contents) + +## C.Display +[[Return to contents]](#Contents) + +## C.XDestroyWindowEvent +[[Return to contents]](#Contents) + +## C.XSelectionClearEvent +[[Return to contents]](#Contents) + +## C.XSelectionEvent +[[Return to contents]](#Contents) + +## C.XSelectionRequestEvent +[[Return to contents]](#Contents) + +## Clipboard +[[Return to contents]](#Contents) + +## check_availability +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## has_ownership +[[Return to contents]](#Contents) + +## set_text +[[Return to contents]](#Contents) + +## get_text +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/compress.deflate.md b/vdocs/compress.deflate.md new file mode 100644 index 00000000..acd1e4e0 --- /dev/null +++ b/vdocs/compress.deflate.md @@ -0,0 +1,28 @@ +# module compress.deflate + + +## Contents +- [compress](#compress) +- [decompress](#decompress) + +## compress +Example +```v + +compressed := deflate.compress(b)! + +``` + +[[Return to contents]](#Contents) + +## decompress +Example +```v + +decompressed := deflate.decompress(b)! + +``` + +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/compress.gzip.md b/vdocs/compress.gzip.md new file mode 100644 index 00000000..937153de --- /dev/null +++ b/vdocs/compress.gzip.md @@ -0,0 +1,66 @@ +# module compress.gzip + + +## Contents +- [Constants](#Constants) +- [compress](#compress) +- [decompress](#decompress) +- [validate](#validate) +- [CompressFlags](#CompressFlags) +- [DecompressFlags](#DecompressFlags) +- [CompressParams](#CompressParams) +- [DecompressParams](#DecompressParams) +- [GzipHeader](#GzipHeader) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## compress +Example +```v + +compressed := gzip.compress(b, compression_level:4095)! + +``` + +[[Return to contents]](#Contents) + +## decompress +Example +```v + +decompressed := gzip.decompress(b)! + +``` + +[[Return to contents]](#Contents) + +## validate +[[Return to contents]](#Contents) + +## CompressFlags +[[Return to contents]](#Contents) + +## DecompressFlags +[[Return to contents]](#Contents) + +## CompressParams +[[Return to contents]](#Contents) + +## DecompressParams +[[Return to contents]](#Contents) + +## GzipHeader +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/compress.md b/vdocs/compress.md new file mode 100644 index 00000000..a9cd9add --- /dev/null +++ b/vdocs/compress.md @@ -0,0 +1,18 @@ +# module compress + + +## Contents +- [Constants](#Constants) +- [compress](#compress) +- [decompress](#decompress) + +## Constants +[[Return to contents]](#Contents) + +## compress +[[Return to contents]](#Contents) + +## decompress +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/compress.szip.md b/vdocs/compress.szip.md new file mode 100644 index 00000000..a74e7642 --- /dev/null +++ b/vdocs/compress.szip.md @@ -0,0 +1,106 @@ +# module compress.szip + + +## Contents +- [extract_zip_to_dir](#extract_zip_to_dir) +- [open](#open) +- [zip_files](#zip_files) +- [zip_folder](#zip_folder) +- [Fn_on_extract_entry](#Fn_on_extract_entry) +- [Zip](#Zip) + - [close](#close) + - [open_entry](#open_entry) + - [open_entry_by_index](#open_entry_by_index) + - [close_entry](#close_entry) + - [name](#name) + - [index](#index) + - [is_dir](#is_dir) + - [size](#size) + - [crc32](#crc32) + - [write_entry](#write_entry) + - [create_entry](#create_entry) + - [read_entry](#read_entry) + - [read_entry_buf](#read_entry_buf) + - [extract_entry](#extract_entry) + - [total](#total) +- [CompressionLevel](#CompressionLevel) +- [OpenMode](#OpenMode) +- [C.zip_t](#C.zip_t) +- [ZipFolderOptions](#ZipFolderOptions) + +## extract_zip_to_dir +[[Return to contents]](#Contents) + +## open +[[Return to contents]](#Contents) + +## zip_files +[[Return to contents]](#Contents) + +## zip_folder +[[Return to contents]](#Contents) + +## Fn_on_extract_entry +[[Return to contents]](#Contents) + +## Zip +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## open_entry +[[Return to contents]](#Contents) + +## open_entry_by_index +[[Return to contents]](#Contents) + +## close_entry +[[Return to contents]](#Contents) + +## name +[[Return to contents]](#Contents) + +## index +[[Return to contents]](#Contents) + +## is_dir +[[Return to contents]](#Contents) + +## size +[[Return to contents]](#Contents) + +## crc32 +[[Return to contents]](#Contents) + +## write_entry +[[Return to contents]](#Contents) + +## create_entry +[[Return to contents]](#Contents) + +## read_entry +[[Return to contents]](#Contents) + +## read_entry_buf +[[Return to contents]](#Contents) + +## extract_entry +[[Return to contents]](#Contents) + +## total +[[Return to contents]](#Contents) + +## CompressionLevel +[[Return to contents]](#Contents) + +## OpenMode +[[Return to contents]](#Contents) + +## C.zip_t +[[Return to contents]](#Contents) + +## ZipFolderOptions +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/compress.zlib.md b/vdocs/compress.zlib.md new file mode 100644 index 00000000..9063a6fe --- /dev/null +++ b/vdocs/compress.zlib.md @@ -0,0 +1,28 @@ +# module compress.zlib + + +## Contents +- [compress](#compress) +- [decompress](#decompress) + +## compress +Example +```v + +compressed := zlib.compress(b)! + +``` + +[[Return to contents]](#Contents) + +## decompress +Example +```v + +decompressed := zlib.decompress(b)! + +``` + +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/compress.zstd.md b/vdocs/compress.zstd.md new file mode 100644 index 00000000..2e8bbcec --- /dev/null +++ b/vdocs/compress.zstd.md @@ -0,0 +1,148 @@ +# module compress.zstd + + +## Contents +- [check_zstd](#check_zstd) +- [compress](#compress) +- [decompress](#decompress) +- [default_c_level](#default_c_level) +- [get_error_name](#get_error_name) +- [is_error](#is_error) +- [load_array](#load_array) +- [max_c_level](#max_c_level) +- [min_c_level](#min_c_level) +- [new_cctx](#new_cctx) +- [new_dctx](#new_dctx) +- [store_array](#store_array) +- [version_number](#version_number) +- [version_string](#version_string) +- [ZSTD_CCtx](#ZSTD_CCtx) + - [set_parameter](#set_parameter) + - [compress_stream2](#compress_stream2) + - [free_cctx](#free_cctx) +- [ZSTD_DCtx](#ZSTD_DCtx) + - [set_parameter](#set_parameter) + - [decompress_stream](#decompress_stream) + - [free_dctx](#free_dctx) +- [ZSTD_EndDirective](#ZSTD_EndDirective) +- [ZSTD_ResetDirective](#ZSTD_ResetDirective) +- [ZSTD_cParameter](#ZSTD_cParameter) +- [ZSTD_dParameter](#ZSTD_dParameter) +- [ZSTD_strategy](#ZSTD_strategy) +- [CompressParams](#CompressParams) +- [DecompressParams](#DecompressParams) +- [ZSTD_bounds](#ZSTD_bounds) +- [ZSTD_inBuffer](#ZSTD_inBuffer) +- [ZSTD_outBuffer](#ZSTD_outBuffer) + +## check_zstd +[[Return to contents]](#Contents) + +## compress +Example +```v + +compressed := zstd.compress(b)! + +``` + +[[Return to contents]](#Contents) + +## decompress +Example +```v + +decompressed := zstd.decompress(b)! + +``` + +[[Return to contents]](#Contents) + +## default_c_level +[[Return to contents]](#Contents) + +## get_error_name +[[Return to contents]](#Contents) + +## is_error +[[Return to contents]](#Contents) + +## load_array +[[Return to contents]](#Contents) + +## max_c_level +[[Return to contents]](#Contents) + +## min_c_level +[[Return to contents]](#Contents) + +## new_cctx +[[Return to contents]](#Contents) + +## new_dctx +[[Return to contents]](#Contents) + +## store_array +[[Return to contents]](#Contents) + +## version_number +[[Return to contents]](#Contents) + +## version_string +[[Return to contents]](#Contents) + +## ZSTD_CCtx +[[Return to contents]](#Contents) + +## set_parameter +[[Return to contents]](#Contents) + +## compress_stream2 +[[Return to contents]](#Contents) + +## free_cctx +[[Return to contents]](#Contents) + +## ZSTD_DCtx +[[Return to contents]](#Contents) + +## set_parameter +[[Return to contents]](#Contents) + +## decompress_stream +[[Return to contents]](#Contents) + +## free_dctx +[[Return to contents]](#Contents) + +## ZSTD_EndDirective +[[Return to contents]](#Contents) + +## ZSTD_ResetDirective +[[Return to contents]](#Contents) + +## ZSTD_cParameter +[[Return to contents]](#Contents) + +## ZSTD_dParameter +[[Return to contents]](#Contents) + +## ZSTD_strategy +[[Return to contents]](#Contents) + +## CompressParams +[[Return to contents]](#Contents) + +## DecompressParams +[[Return to contents]](#Contents) + +## ZSTD_bounds +[[Return to contents]](#Contents) + +## ZSTD_inBuffer +[[Return to contents]](#Contents) + +## ZSTD_outBuffer +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/context.md b/vdocs/context.md new file mode 100644 index 00000000..18481048 --- /dev/null +++ b/vdocs/context.md @@ -0,0 +1,166 @@ +# module context + + +## Contents +- [background](#background) +- [todo](#todo) +- [with_cancel](#with_cancel) +- [with_deadline](#with_deadline) +- [with_timeout](#with_timeout) +- [with_value](#with_value) +- [Any](#Any) +- [Canceler](#Canceler) +- [Context](#Context) + - [str](#str) +- [BackgroundContext](#BackgroundContext) + - [str](#str) +- [CancelFn](#CancelFn) +- [Key](#Key) +- [TodoContext](#TodoContext) + - [str](#str) +- [CancelContext](#CancelContext) + - [deadline](#deadline) + - [done](#done) + - [err](#err) + - [value](#value) + - [str](#str) +- [EmptyContext](#EmptyContext) + - [deadline](#deadline) + - [done](#done) + - [err](#err) + - [value](#value) + - [str](#str) +- [TimerContext](#TimerContext) + - [deadline](#deadline) + - [done](#done) + - [err](#err) + - [value](#value) + - [cancel](#cancel) + - [str](#str) +- [ValueContext](#ValueContext) + - [deadline](#deadline) + - [done](#done) + - [err](#err) + - [value](#value) + - [str](#str) + +## background +[[Return to contents]](#Contents) + +## todo +[[Return to contents]](#Contents) + +## with_cancel +[[Return to contents]](#Contents) + +## with_deadline +[[Return to contents]](#Contents) + +## with_timeout +[[Return to contents]](#Contents) + +## with_value +[[Return to contents]](#Contents) + +## Any +[[Return to contents]](#Contents) + +## Canceler +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## BackgroundContext +## str +[[Return to contents]](#Contents) + +## CancelFn +[[Return to contents]](#Contents) + +## Key +[[Return to contents]](#Contents) + +## TodoContext +## str +[[Return to contents]](#Contents) + +## CancelContext +[[Return to contents]](#Contents) + +## deadline +[[Return to contents]](#Contents) + +## done +[[Return to contents]](#Contents) + +## err +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## EmptyContext +[[Return to contents]](#Contents) + +## deadline +[[Return to contents]](#Contents) + +## done +[[Return to contents]](#Contents) + +## err +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## TimerContext +[[Return to contents]](#Contents) + +## deadline +[[Return to contents]](#Contents) + +## done +[[Return to contents]](#Contents) + +## err +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## cancel +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ValueContext +[[Return to contents]](#Contents) + +## deadline +[[Return to contents]](#Contents) + +## done +[[Return to contents]](#Contents) + +## err +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/context.onecontext.md b/vdocs/context.onecontext.md new file mode 100644 index 00000000..97d57c00 --- /dev/null +++ b/vdocs/context.onecontext.md @@ -0,0 +1,52 @@ +# module context.onecontext + + +## Contents +- [Constants](#Constants) +- [merge](#merge) +- [OneContext](#OneContext) + - [deadline](#deadline) + - [done](#done) + - [err](#err) + - [value](#value) + - [run](#run) + - [str](#str) + - [cancel](#cancel) + - [run_two_contexts](#run_two_contexts) + - [run_multiple_contexts](#run_multiple_contexts) + +## Constants +[[Return to contents]](#Contents) + +## merge +[[Return to contents]](#Contents) + +## OneContext +## deadline +[[Return to contents]](#Contents) + +## done +[[Return to contents]](#Contents) + +## err +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## cancel +[[Return to contents]](#Contents) + +## run_two_contexts +[[Return to contents]](#Contents) + +## run_multiple_contexts +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/coroutines.md b/vdocs/coroutines.md new file mode 100644 index 00000000..9dd2ca0d --- /dev/null +++ b/vdocs/coroutines.md @@ -0,0 +1,10 @@ +# module coroutines + + +## Contents +- [sleep](#sleep) + +## sleep +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.aes.md b/vdocs/crypto.aes.md new file mode 100644 index 00000000..647a14c5 --- /dev/null +++ b/vdocs/crypto.aes.md @@ -0,0 +1,32 @@ +# module crypto.aes + + +## Contents +- [Constants](#Constants) +- [new_cipher](#new_cipher) +- [AesCipher](#AesCipher) + - [free](#free) + - [block_size](#block_size) + - [encrypt](#encrypt) + - [decrypt](#decrypt) + +## Constants +[[Return to contents]](#Contents) + +## new_cipher +[[Return to contents]](#Contents) + +## AesCipher +## free +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## encrypt +[[Return to contents]](#Contents) + +## decrypt +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.bcrypt.md b/vdocs/crypto.bcrypt.md new file mode 100644 index 00000000..7a77ca04 --- /dev/null +++ b/vdocs/crypto.bcrypt.md @@ -0,0 +1,48 @@ +# module crypto.bcrypt + + +## Contents +- [Constants](#Constants) +- [compare_hash_and_password](#compare_hash_and_password) +- [generate_from_password](#generate_from_password) +- [generate_salt](#generate_salt) +- [Hashed](#Hashed) + - [free](#free) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## compare_hash_and_password +[[Return to contents]](#Contents) + +## generate_from_password +[[Return to contents]](#Contents) + +## generate_salt +[[Return to contents]](#Contents) + +## Hashed +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.blake2b.md b/vdocs/crypto.blake2b.md new file mode 100644 index 00000000..0c6451e4 --- /dev/null +++ b/vdocs/crypto.blake2b.md @@ -0,0 +1,100 @@ +# module crypto.blake2b + + +## Contents +- [Constants](#Constants) +- [new160](#new160) +- [new256](#new256) +- [new384](#new384) +- [new512](#new512) +- [new_digest](#new_digest) +- [new_pmac160](#new_pmac160) +- [new_pmac256](#new_pmac256) +- [new_pmac384](#new_pmac384) +- [new_pmac512](#new_pmac512) +- [pmac160](#pmac160) +- [pmac256](#pmac256) +- [pmac384](#pmac384) +- [pmac512](#pmac512) +- [sum160](#sum160) +- [sum256](#sum256) +- [sum384](#sum384) +- [sum512](#sum512) +- [Digest](#Digest) + - [str](#str) + - [write](#write) + - [checksum](#checksum) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new160 +[[Return to contents]](#Contents) + +## new256 +[[Return to contents]](#Contents) + +## new384 +[[Return to contents]](#Contents) + +## new512 +[[Return to contents]](#Contents) + +## new_digest +[[Return to contents]](#Contents) + +## new_pmac160 +[[Return to contents]](#Contents) + +## new_pmac256 +[[Return to contents]](#Contents) + +## new_pmac384 +[[Return to contents]](#Contents) + +## new_pmac512 +[[Return to contents]](#Contents) + +## pmac160 +[[Return to contents]](#Contents) + +## pmac256 +[[Return to contents]](#Contents) + +## pmac384 +[[Return to contents]](#Contents) + +## pmac512 +[[Return to contents]](#Contents) + +## sum160 +[[Return to contents]](#Contents) + +## sum256 +[[Return to contents]](#Contents) + +## sum384 +[[Return to contents]](#Contents) + +## sum512 +[[Return to contents]](#Contents) + +## Digest +## str +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## checksum +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.blake2s.md b/vdocs/crypto.blake2s.md new file mode 100644 index 00000000..01477595 --- /dev/null +++ b/vdocs/crypto.blake2s.md @@ -0,0 +1,100 @@ +# module crypto.blake2s + + +## Contents +- [Constants](#Constants) +- [new128](#new128) +- [new160](#new160) +- [new224](#new224) +- [new256](#new256) +- [new_digest](#new_digest) +- [new_pmac128](#new_pmac128) +- [new_pmac160](#new_pmac160) +- [new_pmac224](#new_pmac224) +- [new_pmac256](#new_pmac256) +- [pmac128](#pmac128) +- [pmac160](#pmac160) +- [pmac224](#pmac224) +- [pmac256](#pmac256) +- [sum128](#sum128) +- [sum160](#sum160) +- [sum224](#sum224) +- [sum256](#sum256) +- [Digest](#Digest) + - [str](#str) + - [write](#write) + - [checksum](#checksum) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new128 +[[Return to contents]](#Contents) + +## new160 +[[Return to contents]](#Contents) + +## new224 +[[Return to contents]](#Contents) + +## new256 +[[Return to contents]](#Contents) + +## new_digest +[[Return to contents]](#Contents) + +## new_pmac128 +[[Return to contents]](#Contents) + +## new_pmac160 +[[Return to contents]](#Contents) + +## new_pmac224 +[[Return to contents]](#Contents) + +## new_pmac256 +[[Return to contents]](#Contents) + +## pmac128 +[[Return to contents]](#Contents) + +## pmac160 +[[Return to contents]](#Contents) + +## pmac224 +[[Return to contents]](#Contents) + +## pmac256 +[[Return to contents]](#Contents) + +## sum128 +[[Return to contents]](#Contents) + +## sum160 +[[Return to contents]](#Contents) + +## sum224 +[[Return to contents]](#Contents) + +## sum256 +[[Return to contents]](#Contents) + +## Digest +## str +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## checksum +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.blake3.md b/vdocs/crypto.blake3.md new file mode 100644 index 00000000..fd70baa6 --- /dev/null +++ b/vdocs/crypto.blake3.md @@ -0,0 +1,50 @@ +# module crypto.blake3 + + +## Contents +- [Constants](#Constants) +- [sum256](#sum256) +- [sum_derive_key256](#sum_derive_key256) +- [sum_keyed256](#sum_keyed256) +- [Digest.new_derive_key_hash](#Digest.new_derive_key_hash) +- [Digest.new_hash](#Digest.new_hash) +- [Digest.new_keyed_hash](#Digest.new_keyed_hash) +- [Digest](#Digest) + - [write](#write) + - [checksum](#checksum) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## sum256 +[[Return to contents]](#Contents) + +## sum_derive_key256 +[[Return to contents]](#Contents) + +## sum_keyed256 +[[Return to contents]](#Contents) + +## Digest.new_derive_key_hash +[[Return to contents]](#Contents) + +## Digest.new_hash +[[Return to contents]](#Contents) + +## Digest.new_keyed_hash +[[Return to contents]](#Contents) + +## Digest +## write +[[Return to contents]](#Contents) + +## checksum +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.blowfish.md b/vdocs/crypto.blowfish.md new file mode 100644 index 00000000..f60d6672 --- /dev/null +++ b/vdocs/crypto.blowfish.md @@ -0,0 +1,36 @@ +# module crypto.blowfish + + +## Contents +- [Constants](#Constants) +- [expand_key](#expand_key) +- [expand_key_with_salt](#expand_key_with_salt) +- [new_cipher](#new_cipher) +- [new_salted_cipher](#new_salted_cipher) +- [Blowfish](#Blowfish) + - [encrypt](#encrypt) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## expand_key +[[Return to contents]](#Contents) + +## expand_key_with_salt +[[Return to contents]](#Contents) + +## new_cipher +[[Return to contents]](#Contents) + +## new_salted_cipher +[[Return to contents]](#Contents) + +## Blowfish +[[Return to contents]](#Contents) + +## encrypt +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.cipher.md b/vdocs/crypto.cipher.md new file mode 100644 index 00000000..d3e96e4a --- /dev/null +++ b/vdocs/crypto.cipher.md @@ -0,0 +1,90 @@ +# module crypto.cipher + + +## Contents +- [new_cbc](#new_cbc) +- [new_cfb_decrypter](#new_cfb_decrypter) +- [new_cfb_encrypter](#new_cfb_encrypter) +- [new_ctr](#new_ctr) +- [new_ofb](#new_ofb) +- [safe_xor_bytes](#safe_xor_bytes) +- [xor_bytes](#xor_bytes) +- [xor_words](#xor_words) +- [Block](#Block) +- [BlockMode](#BlockMode) +- [Stream](#Stream) +- [Cbc](#Cbc) + - [free](#free) + - [encrypt_blocks](#encrypt_blocks) + - [decrypt_blocks](#decrypt_blocks) +- [Cfb](#Cfb) + - [free](#free) + - [xor_key_stream](#xor_key_stream) +- [Ctr](#Ctr) + - [free](#free) + - [xor_key_stream](#xor_key_stream) +- [Ofb](#Ofb) + - [xor_key_stream](#xor_key_stream) + +## new_cbc +[[Return to contents]](#Contents) + +## new_cfb_decrypter +[[Return to contents]](#Contents) + +## new_cfb_encrypter +[[Return to contents]](#Contents) + +## new_ctr +[[Return to contents]](#Contents) + +## new_ofb +[[Return to contents]](#Contents) + +## safe_xor_bytes +[[Return to contents]](#Contents) + +## xor_bytes +[[Return to contents]](#Contents) + +## xor_words +[[Return to contents]](#Contents) + +## Block +[[Return to contents]](#Contents) + +## BlockMode +[[Return to contents]](#Contents) + +## Stream +[[Return to contents]](#Contents) + +## Cbc +## free +[[Return to contents]](#Contents) + +## encrypt_blocks +[[Return to contents]](#Contents) + +## decrypt_blocks +[[Return to contents]](#Contents) + +## Cfb +## free +[[Return to contents]](#Contents) + +## xor_key_stream +[[Return to contents]](#Contents) + +## Ctr +## free +[[Return to contents]](#Contents) + +## xor_key_stream +[[Return to contents]](#Contents) + +## Ofb +## xor_key_stream +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.des.md b/vdocs/crypto.des.md new file mode 100644 index 00000000..8b0b2094 --- /dev/null +++ b/vdocs/crypto.des.md @@ -0,0 +1,38 @@ +# module crypto.des + + +## Contents +- [encrypt_block](#encrypt_block) +- [new_cipher](#new_cipher) +- [new_triple_des_cipher](#new_triple_des_cipher) +- [DesCipher](#DesCipher) + - [encrypt](#encrypt) + - [decrypt](#decrypt) +- [TripleDesCipher](#TripleDesCipher) + - [encrypt](#encrypt) + - [decrypt](#decrypt) + +## encrypt_block +[[Return to contents]](#Contents) + +## new_cipher +[[Return to contents]](#Contents) + +## new_triple_des_cipher +[[Return to contents]](#Contents) + +## DesCipher +## encrypt +[[Return to contents]](#Contents) + +## decrypt +[[Return to contents]](#Contents) + +## TripleDesCipher +## encrypt +[[Return to contents]](#Contents) + +## decrypt +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.ecdsa.md b/vdocs/crypto.ecdsa.md new file mode 100644 index 00000000..d455a1ab --- /dev/null +++ b/vdocs/crypto.ecdsa.md @@ -0,0 +1,102 @@ +# module crypto.ecdsa + + +## Contents +- [generate_key](#generate_key) +- [new_key_from_seed](#new_key_from_seed) +- [privkey_from_string](#privkey_from_string) +- [pubkey_from_bytes](#pubkey_from_bytes) +- [pubkey_from_string](#pubkey_from_string) +- [PrivateKey.new](#PrivateKey.new) +- [HashConfig](#HashConfig) +- [Nid](#Nid) +- [C.BIO](#C.BIO) +- [CurveOptions](#CurveOptions) +- [PrivateKey](#PrivateKey) + - [sign](#sign) + - [sign_with_options](#sign_with_options) + - [bytes](#bytes) + - [seed](#seed) + - [public_key](#public_key) + - [equal](#equal) + - [free](#free) +- [PublicKey](#PublicKey) + - [bytes](#bytes) + - [equal](#equal) + - [free](#free) + - [verify](#verify) +- [SignerOpts](#SignerOpts) + +## generate_key +[[Return to contents]](#Contents) + +## new_key_from_seed +[[Return to contents]](#Contents) + +## privkey_from_string +[[Return to contents]](#Contents) + +## pubkey_from_bytes +[[Return to contents]](#Contents) + +## pubkey_from_string +[[Return to contents]](#Contents) + +## PrivateKey.new +[[Return to contents]](#Contents) + +## HashConfig +[[Return to contents]](#Contents) + +## Nid +[[Return to contents]](#Contents) + +## C.BIO +[[Return to contents]](#Contents) + +## CurveOptions +[[Return to contents]](#Contents) + +## PrivateKey +[[Return to contents]](#Contents) + +## sign +[[Return to contents]](#Contents) + +## sign_with_options +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## public_key +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## PublicKey +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## verify +[[Return to contents]](#Contents) + +## SignerOpts +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.ed25519.internal.edwards25519.md b/vdocs/crypto.ed25519.internal.edwards25519.md new file mode 100644 index 00000000..fb0af546 --- /dev/null +++ b/vdocs/crypto.ed25519.internal.edwards25519.md @@ -0,0 +1,224 @@ +# module crypto.ed25519.internal.edwards25519 + + +## Contents +- [Constants](#Constants) +- [new_generator_point](#new_generator_point) +- [new_identity_point](#new_identity_point) +- [new_scalar](#new_scalar) +- [Scalar](#Scalar) + - [add](#add) + - [bytes](#bytes) + - [equal](#equal) + - [invert](#invert) + - [multiply](#multiply) + - [multiply_add](#multiply_add) + - [negate](#negate) + - [non_adjacent_form](#non_adjacent_form) + - [set](#set) + - [set_bytes_with_clamping](#set_bytes_with_clamping) + - [set_canonical_bytes](#set_canonical_bytes) + - [set_uniform_bytes](#set_uniform_bytes) + - [subtract](#subtract) +- [Element](#Element) + - [zero](#zero) + - [one](#one) + - [reduce](#reduce) + - [add](#add) + - [subtract](#subtract) + - [negate](#negate) + - [invert](#invert) + - [square](#square) + - [multiply](#multiply) + - [pow_22523](#pow_22523) + - [sqrt_ratio](#sqrt_ratio) + - [selected](#selected) + - [is_negative](#is_negative) + - [absolute](#absolute) + - [set](#set) + - [set_bytes](#set_bytes) + - [bytes](#bytes) + - [equal](#equal) + - [swap](#swap) + - [mult_32](#mult_32) +- [Point](#Point) + - [add](#add) + - [bytes](#bytes) + - [bytes_montgomery](#bytes_montgomery) + - [equal](#equal) + - [mult_by_cofactor](#mult_by_cofactor) + - [multi_scalar_mult](#multi_scalar_mult) + - [negate](#negate) + - [scalar_base_mult](#scalar_base_mult) + - [scalar_mult](#scalar_mult) + - [set](#set) + - [set_bytes](#set_bytes) + - [subtract](#subtract) + - [vartime_double_scalar_base_mult](#vartime_double_scalar_base_mult) + - [vartime_multiscalar_mult](#vartime_multiscalar_mult) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new_generator_point +[[Return to contents]](#Contents) + +## new_identity_point +[[Return to contents]](#Contents) + +## new_scalar +[[Return to contents]](#Contents) + +## Scalar +## add +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## invert +[[Return to contents]](#Contents) + +## multiply +[[Return to contents]](#Contents) + +## multiply_add +[[Return to contents]](#Contents) + +## negate +[[Return to contents]](#Contents) + +## non_adjacent_form +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## set_bytes_with_clamping +[[Return to contents]](#Contents) + +## set_canonical_bytes +[[Return to contents]](#Contents) + +## set_uniform_bytes +[[Return to contents]](#Contents) + +## subtract +[[Return to contents]](#Contents) + +## Element +[[Return to contents]](#Contents) + +## zero +[[Return to contents]](#Contents) + +## one +[[Return to contents]](#Contents) + +## reduce +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## subtract +[[Return to contents]](#Contents) + +## negate +[[Return to contents]](#Contents) + +## invert +[[Return to contents]](#Contents) + +## square +[[Return to contents]](#Contents) + +## multiply +[[Return to contents]](#Contents) + +## pow_22523 +[[Return to contents]](#Contents) + +## sqrt_ratio +[[Return to contents]](#Contents) + +## selected +[[Return to contents]](#Contents) + +## is_negative +[[Return to contents]](#Contents) + +## absolute +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## set_bytes +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## swap +[[Return to contents]](#Contents) + +## mult_32 +[[Return to contents]](#Contents) + +## Point +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## bytes_montgomery +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## mult_by_cofactor +[[Return to contents]](#Contents) + +## multi_scalar_mult +[[Return to contents]](#Contents) + +## negate +[[Return to contents]](#Contents) + +## scalar_base_mult +[[Return to contents]](#Contents) + +## scalar_mult +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## set_bytes +[[Return to contents]](#Contents) + +## subtract +[[Return to contents]](#Contents) + +## vartime_double_scalar_base_mult +[[Return to contents]](#Contents) + +## vartime_multiscalar_mult +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.ed25519.md b/vdocs/crypto.ed25519.md new file mode 100644 index 00000000..78995482 --- /dev/null +++ b/vdocs/crypto.ed25519.md @@ -0,0 +1,60 @@ +# module crypto.ed25519 + + +## Contents +- [Constants](#Constants) +- [generate_key](#generate_key) +- [new_key_from_seed](#new_key_from_seed) +- [sign](#sign) +- [verify](#verify) +- [PrivateKey](#PrivateKey) + - [seed](#seed) + - [public_key](#public_key) + - [equal](#equal) + - [sign](#sign) +- [PublicKey](#PublicKey) + - [equal](#equal) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## generate_key +[[Return to contents]](#Contents) + +## new_key_from_seed +[[Return to contents]](#Contents) + +## sign +[[Return to contents]](#Contents) + +## verify +[[Return to contents]](#Contents) + +## PrivateKey +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## public_key +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## sign +[[Return to contents]](#Contents) + +## PublicKey +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.hmac.md b/vdocs/crypto.hmac.md new file mode 100644 index 00000000..283e7061 --- /dev/null +++ b/vdocs/crypto.hmac.md @@ -0,0 +1,14 @@ +# module crypto.hmac + + +## Contents +- [equal](#equal) +- [new](#new) + +## equal +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.internal.subtle.md b/vdocs/crypto.internal.subtle.md new file mode 100644 index 00000000..818923e7 --- /dev/null +++ b/vdocs/crypto.internal.subtle.md @@ -0,0 +1,38 @@ +# module crypto.internal.subtle + + +## Contents +- [any_overlap](#any_overlap) +- [constant_time_byte_eq](#constant_time_byte_eq) +- [constant_time_compare](#constant_time_compare) +- [constant_time_copy](#constant_time_copy) +- [constant_time_eq](#constant_time_eq) +- [constant_time_less_or_eq](#constant_time_less_or_eq) +- [constant_time_select](#constant_time_select) +- [inexact_overlap](#inexact_overlap) + +## any_overlap +[[Return to contents]](#Contents) + +## constant_time_byte_eq +[[Return to contents]](#Contents) + +## constant_time_compare +[[Return to contents]](#Contents) + +## constant_time_copy +[[Return to contents]](#Contents) + +## constant_time_eq +[[Return to contents]](#Contents) + +## constant_time_less_or_eq +[[Return to contents]](#Contents) + +## constant_time_select +[[Return to contents]](#Contents) + +## inexact_overlap +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.md b/vdocs/crypto.md new file mode 100644 index 00000000..a7dfdb80 --- /dev/null +++ b/vdocs/crypto.md @@ -0,0 +1,10 @@ +# module crypto + + +## Contents +- [Hash](#Hash) + +## Hash +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.md5.md b/vdocs/crypto.md5.md new file mode 100644 index 00000000..fd6f08eb --- /dev/null +++ b/vdocs/crypto.md5.md @@ -0,0 +1,57 @@ +# module crypto.md5 + + +## Contents +- [Constants](#Constants) +- [hexhash](#hexhash) +- [new](#new) +- [sum](#sum) +- [Digest](#Digest) + - [free](#free) + - [reset](#reset) + - [write](#write) + - [sum](#sum) + - [size](#size) + - [block_size](#block_size) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## hexhash +Example +```v + +assert md5.hexhash('V') == '5206560a306a2e085a437fd258eb57ce' + +``` + +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## Digest +## free +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## size +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.pbkdf2.md b/vdocs/crypto.pbkdf2.md new file mode 100644 index 00000000..b19f3378 --- /dev/null +++ b/vdocs/crypto.pbkdf2.md @@ -0,0 +1,10 @@ +# module crypto.pbkdf2 + + +## Contents +- [key](#key) + +## key +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.pem.md b/vdocs/crypto.pem.md new file mode 100644 index 00000000..3803982f --- /dev/null +++ b/vdocs/crypto.pem.md @@ -0,0 +1,46 @@ +# module crypto.pem + + +## Contents +- [decode](#decode) +- [decode_only](#decode_only) +- [Block.new](#Block.new) +- [Header](#Header) + - [str](#str) +- [Block](#Block) + - [encode](#encode) + - [free](#free) + - [header_by_key](#header_by_key) +- [EncodeConfig](#EncodeConfig) + +## decode +[[Return to contents]](#Contents) + +## decode_only +[[Return to contents]](#Contents) + +## Block.new +[[Return to contents]](#Contents) + +## Header +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Block +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## header_by_key +[[Return to contents]](#Contents) + +## EncodeConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.rand.md b/vdocs/crypto.rand.md new file mode 100644 index 00000000..dfbb88fb --- /dev/null +++ b/vdocs/crypto.rand.md @@ -0,0 +1,28 @@ +# module crypto.rand + + +## Contents +- [bytes](#bytes) +- [int_big](#int_big) +- [int_u64](#int_u64) +- [read](#read) +- [ReadError](#ReadError) + - [msg](#msg) + +## bytes +[[Return to contents]](#Contents) + +## int_big +[[Return to contents]](#Contents) + +## int_u64 +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## ReadError +## msg +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.rc4.md b/vdocs/crypto.rc4.md new file mode 100644 index 00000000..4d7f92a7 --- /dev/null +++ b/vdocs/crypto.rc4.md @@ -0,0 +1,24 @@ +# module crypto.rc4 + + +## Contents +- [new_cipher](#new_cipher) +- [Cipher](#Cipher) + - [free](#free) + - [reset](#reset) + - [xor_key_stream](#xor_key_stream) + +## new_cipher +[[Return to contents]](#Contents) + +## Cipher +## free +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## xor_key_stream +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.scrypt.md b/vdocs/crypto.scrypt.md new file mode 100644 index 00000000..caeab19a --- /dev/null +++ b/vdocs/crypto.scrypt.md @@ -0,0 +1,16 @@ +# module crypto.scrypt + + +## Contents +- [Constants](#Constants) +- [scrypt](#scrypt) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## scrypt +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.sha1.md b/vdocs/crypto.sha1.md new file mode 100644 index 00000000..3aa2dc7f --- /dev/null +++ b/vdocs/crypto.sha1.md @@ -0,0 +1,50 @@ +# module crypto.sha1 + + +## Contents +- [Constants](#Constants) +- [hexhash](#hexhash) +- [new](#new) +- [sum](#sum) +- [Digest](#Digest) + - [free](#free) + - [reset](#reset) + - [write](#write) + - [sum](#sum) + - [size](#size) + - [block_size](#block_size) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## hexhash +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## Digest +## free +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## size +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.sha256.md b/vdocs/crypto.sha256.md new file mode 100644 index 00000000..724e814c --- /dev/null +++ b/vdocs/crypto.sha256.md @@ -0,0 +1,82 @@ +# module crypto.sha256 + + +## Contents +- [Constants](#Constants) +- [hexhash](#hexhash) +- [hexhash_224](#hexhash_224) +- [new](#new) +- [new224](#new224) +- [sum](#sum) +- [sum224](#sum224) +- [sum256](#sum256) +- [Digest](#Digest) + - [free](#free) + - [reset](#reset) + - [write](#write) + - [sum](#sum) + - [size](#size) + - [block_size](#block_size) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## hexhash +Example +```v + +assert sha256.hexhash('V') == 'de5a6f78116eca62d7fc5ce159d23ae6b889b365a1739ad2cf36f925a140d0cc' + +``` + +[[Return to contents]](#Contents) + +## hexhash_224 +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## new224 +[[Return to contents]](#Contents) + +## sum +Example +```v + +assert sha256.sum('V'.bytes()).len > 0 == true + +``` + +[[Return to contents]](#Contents) + +## sum224 +[[Return to contents]](#Contents) + +## sum256 +[[Return to contents]](#Contents) + +## Digest +## free +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## size +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.sha3.md b/vdocs/crypto.sha3.md new file mode 100644 index 00000000..968e4df0 --- /dev/null +++ b/vdocs/crypto.sha3.md @@ -0,0 +1,118 @@ +# module crypto.sha3 + + +## Contents +- [Constants](#Constants) +- [keccak256](#keccak256) +- [keccak512](#keccak512) +- [new128xof](#new128xof) +- [new224](#new224) +- [new256](#new256) +- [new256keccak](#new256keccak) +- [new256xof](#new256xof) +- [new384](#new384) +- [new512](#new512) +- [new512keccak](#new512keccak) +- [new_digest](#new_digest) +- [new_xof_digest](#new_xof_digest) +- [shake128](#shake128) +- [shake256](#shake256) +- [sum224](#sum224) +- [sum256](#sum256) +- [sum384](#sum384) +- [sum512](#sum512) +- [Digest](#Digest) + - [write](#write) + - [checksum](#checksum) +- [Padding](#Padding) +- [PaddingConfig](#PaddingConfig) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## keccak256 +[[Return to contents]](#Contents) + +## keccak512 +[[Return to contents]](#Contents) + +## new128xof +[[Return to contents]](#Contents) + +## new224 +[[Return to contents]](#Contents) + +## new256 +[[Return to contents]](#Contents) + +## new256keccak +[[Return to contents]](#Contents) + +## new256xof +[[Return to contents]](#Contents) + +## new384 +[[Return to contents]](#Contents) + +## new512 +[[Return to contents]](#Contents) + +## new512keccak +[[Return to contents]](#Contents) + +## new_digest +[[Return to contents]](#Contents) + +## new_xof_digest +[[Return to contents]](#Contents) + +## shake128 +[[Return to contents]](#Contents) + +## shake256 +[[Return to contents]](#Contents) + +## sum224 +[[Return to contents]](#Contents) + +## sum256 +[[Return to contents]](#Contents) + +## sum384 +[[Return to contents]](#Contents) + +## sum512 +[[Return to contents]](#Contents) + +## Digest +## write +[[Return to contents]](#Contents) + +## checksum +[[Return to contents]](#Contents) + +## Padding +[[Return to contents]](#Contents) + +## PaddingConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/crypto.sha512.md b/vdocs/crypto.sha512.md new file mode 100644 index 00000000..c0a75eea --- /dev/null +++ b/vdocs/crypto.sha512.md @@ -0,0 +1,92 @@ +# module crypto.sha512 + + +## Contents +- [Constants](#Constants) +- [hexhash](#hexhash) +- [hexhash_384](#hexhash_384) +- [hexhash_512_224](#hexhash_512_224) +- [hexhash_512_256](#hexhash_512_256) +- [new](#new) +- [new384](#new384) +- [new512_224](#new512_224) +- [new512_256](#new512_256) +- [sum384](#sum384) +- [sum512](#sum512) +- [sum512_224](#sum512_224) +- [sum512_256](#sum512_256) +- [Digest](#Digest) + - [free](#free) + - [reset](#reset) + - [write](#write) + - [sum](#sum) + - [size](#size) + - [block_size](#block_size) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## hexhash +[[Return to contents]](#Contents) + +## hexhash_384 +[[Return to contents]](#Contents) + +## hexhash_512_224 +[[Return to contents]](#Contents) + +## hexhash_512_256 +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## new384 +[[Return to contents]](#Contents) + +## new512_224 +[[Return to contents]](#Contents) + +## new512_256 +[[Return to contents]](#Contents) + +## sum384 +[[Return to contents]](#Contents) + +## sum512 +[[Return to contents]](#Contents) + +## sum512_224 +[[Return to contents]](#Contents) + +## sum512_256 +[[Return to contents]](#Contents) + +## Digest +## free +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## size +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/datatypes.fsm.md b/vdocs/datatypes.fsm.md new file mode 100644 index 00000000..146139b9 --- /dev/null +++ b/vdocs/datatypes.fsm.md @@ -0,0 +1,42 @@ +# module datatypes.fsm + + +## Contents +- [new](#new) +- [ConditionFn](#ConditionFn) +- [EventHandlerFn](#EventHandlerFn) +- [StateMachine](#StateMachine) + - [set_state](#set_state) + - [get_state](#get_state) + - [add_state](#add_state) + - [add_transition](#add_transition) + - [run](#run) + +## new +[[Return to contents]](#Contents) + +## ConditionFn +[[Return to contents]](#Contents) + +## EventHandlerFn +[[Return to contents]](#Contents) + +## StateMachine +[[Return to contents]](#Contents) + +## set_state +[[Return to contents]](#Contents) + +## get_state +[[Return to contents]](#Contents) + +## add_state +[[Return to contents]](#Contents) + +## add_transition +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/datatypes.md b/vdocs/datatypes.md new file mode 100644 index 00000000..8bfafa46 --- /dev/null +++ b/vdocs/datatypes.md @@ -0,0 +1,510 @@ +# module datatypes + + +## Contents +- [new_bloom_filter](#new_bloom_filter) +- [new_bloom_filter_fast](#new_bloom_filter_fast) +- [new_ringbuffer](#new_ringbuffer) +- [BSTree[T]](#BSTree[T]) + - [insert](#insert) + - [contains](#contains) + - [remove](#remove) + - [is_empty](#is_empty) + - [in_order_traversal](#in_order_traversal) + - [post_order_traversal](#post_order_traversal) + - [pre_order_traversal](#pre_order_traversal) + - [to_left](#to_left) + - [to_right](#to_right) + - [max](#max) + - [min](#min) +- [BloomFilter[T]](#BloomFilter[T]) + - [add](#add) + - [exists](#exists) + - [@union](#@union) + - [intersection](#intersection) +- [DoublyLinkedList[T]](#DoublyLinkedList[T]) + - [is_empty](#is_empty) + - [len](#len) + - [first](#first) + - [last](#last) + - [push_back](#push_back) + - [push_front](#push_front) + - [push_many](#push_many) + - [pop_back](#pop_back) + - [pop_front](#pop_front) + - [insert](#insert) + - [index](#index) + - [delete](#delete) + - [str](#str) + - [array](#array) + - [next](#next) + - [iterator](#iterator) + - [back_iterator](#back_iterator) +- [DoublyListIterBack[T]](#DoublyListIterBack[T]) + - [next](#next) +- [DoublyListIter[T]](#DoublyListIter[T]) + - [next](#next) +- [LinkedList[T]](#LinkedList[T]) + - [is_empty](#is_empty) + - [len](#len) + - [first](#first) + - [last](#last) + - [index](#index) + - [push](#push) + - [push_many](#push_many) + - [pop](#pop) + - [shift](#shift) + - [insert](#insert) + - [prepend](#prepend) + - [str](#str) + - [array](#array) + - [next](#next) + - [iterator](#iterator) +- [ListIter[T]](#ListIter[T]) + - [next](#next) +- [MinHeap[T]](#MinHeap[T]) + - [insert](#insert) + - [insert_many](#insert_many) + - [pop](#pop) + - [peek](#peek) + - [len](#len) +- [Queue[T]](#Queue[T]) + - [is_empty](#is_empty) + - [len](#len) + - [peek](#peek) + - [last](#last) + - [index](#index) + - [push](#push) + - [pop](#pop) + - [str](#str) + - [array](#array) +- [RingBuffer[T]](#RingBuffer[T]) + - [push](#push) + - [pop](#pop) + - [push_many](#push_many) + - [pop_many](#pop_many) + - [is_empty](#is_empty) + - [is_full](#is_full) + - [capacity](#capacity) + - [clear](#clear) + - [occupied](#occupied) + - [remaining](#remaining) +- [Set[T]](#Set[T]) + - [exists](#exists) + - [add](#add) + - [remove](#remove) + - [pick](#pick) + - [rest](#rest) + - [pop](#pop) + - [clear](#clear) + - [==](#==) + - [is_empty](#is_empty) + - [size](#size) + - [copy](#copy) + - [add_all](#add_all) + - [@union](#@union) + - [intersection](#intersection) + - [-](#-) + - [subset](#subset) +- [Stack[T]](#Stack[T]) + - [is_empty](#is_empty) + - [len](#len) + - [peek](#peek) + - [push](#push) + - [pop](#pop) + - [str](#str) + - [array](#array) +- [Direction](#Direction) +- [AABB](#AABB) +- [BSTree](#BSTree) +- [DoublyLinkedList](#DoublyLinkedList) +- [DoublyListIter](#DoublyListIter) +- [DoublyListIterBack](#DoublyListIterBack) +- [LinkedList](#LinkedList) +- [ListIter](#ListIter) +- [ListNode](#ListNode) +- [MinHeap](#MinHeap) +- [Quadtree](#Quadtree) + - [create](#create) + - [insert](#insert) + - [retrieve](#retrieve) + - [clear](#clear) + - [get_nodes](#get_nodes) +- [Queue](#Queue) +- [RingBuffer](#RingBuffer) +- [Set](#Set) +- [Stack](#Stack) + +## new_bloom_filter +[[Return to contents]](#Contents) + +## new_bloom_filter_fast +[[Return to contents]](#Contents) + +## new_ringbuffer +[[Return to contents]](#Contents) + +## BSTree[T] +## insert +[[Return to contents]](#Contents) + +## contains +[[Return to contents]](#Contents) + +## remove +[[Return to contents]](#Contents) + +## is_empty +[[Return to contents]](#Contents) + +## in_order_traversal +[[Return to contents]](#Contents) + +## post_order_traversal +[[Return to contents]](#Contents) + +## pre_order_traversal +[[Return to contents]](#Contents) + +## to_left +[[Return to contents]](#Contents) + +## to_right +[[Return to contents]](#Contents) + +## max +[[Return to contents]](#Contents) + +## min +[[Return to contents]](#Contents) + +## BloomFilter[T] +## add +[[Return to contents]](#Contents) + +## exists +[[Return to contents]](#Contents) + +## @union +[[Return to contents]](#Contents) + +## intersection +[[Return to contents]](#Contents) + +## DoublyLinkedList[T] +## is_empty +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## first +[[Return to contents]](#Contents) + +## last +[[Return to contents]](#Contents) + +## push_back +[[Return to contents]](#Contents) + +## push_front +[[Return to contents]](#Contents) + +## push_many +[[Return to contents]](#Contents) + +## pop_back +[[Return to contents]](#Contents) + +## pop_front +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## index +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## array +[[Return to contents]](#Contents) + +## next +[[Return to contents]](#Contents) + +## iterator +[[Return to contents]](#Contents) + +## back_iterator +[[Return to contents]](#Contents) + +## DoublyListIterBack[T] +## next +[[Return to contents]](#Contents) + +## DoublyListIter[T] +## next +[[Return to contents]](#Contents) + +## LinkedList[T] +## is_empty +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## first +[[Return to contents]](#Contents) + +## last +[[Return to contents]](#Contents) + +## index +[[Return to contents]](#Contents) + +## push +[[Return to contents]](#Contents) + +## push_many +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## shift +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## prepend +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## array +[[Return to contents]](#Contents) + +## next +[[Return to contents]](#Contents) + +## iterator +[[Return to contents]](#Contents) + +## ListIter[T] +## next +[[Return to contents]](#Contents) + +## MinHeap[T] +## insert +[[Return to contents]](#Contents) + +## insert_many +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## peek +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## Queue[T] +## is_empty +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## peek +[[Return to contents]](#Contents) + +## last +[[Return to contents]](#Contents) + +## index +[[Return to contents]](#Contents) + +## push +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## array +[[Return to contents]](#Contents) + +## RingBuffer[T] +## push +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## push_many +[[Return to contents]](#Contents) + +## pop_many +[[Return to contents]](#Contents) + +## is_empty +[[Return to contents]](#Contents) + +## is_full +[[Return to contents]](#Contents) + +## capacity +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## occupied +[[Return to contents]](#Contents) + +## remaining +[[Return to contents]](#Contents) + +## Set[T] +## exists +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## remove +[[Return to contents]](#Contents) + +## pick +[[Return to contents]](#Contents) + +## rest +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## == +[[Return to contents]](#Contents) + +## is_empty +[[Return to contents]](#Contents) + +## size +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## add_all +[[Return to contents]](#Contents) + +## @union +[[Return to contents]](#Contents) + +## intersection +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## subset +[[Return to contents]](#Contents) + +## Stack[T] +## is_empty +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## peek +[[Return to contents]](#Contents) + +## push +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## array +[[Return to contents]](#Contents) + +## Direction +[[Return to contents]](#Contents) + +## AABB +[[Return to contents]](#Contents) + +## BSTree +[[Return to contents]](#Contents) + +## DoublyLinkedList +[[Return to contents]](#Contents) + +## DoublyListIter +[[Return to contents]](#Contents) + +## DoublyListIterBack +[[Return to contents]](#Contents) + +## LinkedList +[[Return to contents]](#Contents) + +## ListIter +[[Return to contents]](#Contents) + +## ListNode +[[Return to contents]](#Contents) + +## MinHeap +[[Return to contents]](#Contents) + +## Quadtree +[[Return to contents]](#Contents) + +## create +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## retrieve +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## get_nodes +[[Return to contents]](#Contents) + +## Queue +[[Return to contents]](#Contents) + +## RingBuffer +[[Return to contents]](#Contents) + +## Set +[[Return to contents]](#Contents) + +## Stack +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/db.mssql.md b/vdocs/db.mssql.md new file mode 100644 index 00000000..c1efc3b1 --- /dev/null +++ b/vdocs/db.mssql.md @@ -0,0 +1,38 @@ +# module db.mssql + + +## Contents +- [Config](#Config) + - [get_conn_str](#get_conn_str) +- [Connection](#Connection) + - [connect](#connect) + - [close](#close) + - [query](#query) +- [Result](#Result) +- [Row](#Row) + +## Config +[[Return to contents]](#Contents) + +## get_conn_str +[[Return to contents]](#Contents) + +## Connection +[[Return to contents]](#Contents) + +## connect +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## query +[[Return to contents]](#Contents) + +## Result +[[Return to contents]](#Contents) + +## Row +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/db.mysql.md b/vdocs/db.mysql.md new file mode 100644 index 00000000..98ef144c --- /dev/null +++ b/vdocs/db.mysql.md @@ -0,0 +1,400 @@ +# module db.mysql + + +## Contents +- [Constants](#Constants) +- [connect](#connect) +- [debug](#debug) +- [get_client_info](#get_client_info) +- [get_client_version](#get_client_version) +- [ConnectionFlag](#ConnectionFlag) +- [FieldType](#FieldType) + - [str](#str) + - [get_len](#get_len) +- [C.MYSQL](#C.MYSQL) +- [C.MYSQL_BIND](#C.MYSQL_BIND) +- [C.MYSQL_FIELD](#C.MYSQL_FIELD) +- [C.MYSQL_RES](#C.MYSQL_RES) +- [C.MYSQL_STMT](#C.MYSQL_STMT) +- [Config](#Config) +- [DB](#DB) + - [affected_rows](#affected_rows) + - [autocommit](#autocommit) + - [change_user](#change_user) + - [close](#close) + - [commit](#commit) + - [create](#create) + - [delete](#delete) + - [drop](#drop) + - [dump_debug_info](#dump_debug_info) + - [escape_string](#escape_string) + - [exec](#exec) + - [exec_none](#exec_none) + - [exec_one](#exec_one) + - [exec_param](#exec_param) + - [exec_param_many](#exec_param_many) + - [get_host_info](#get_host_info) + - [get_option](#get_option) + - [get_server_info](#get_server_info) + - [get_server_version](#get_server_version) + - [info](#info) + - [init_stmt](#init_stmt) + - [insert](#insert) + - [last_id](#last_id) + - [ping](#ping) + - [prepare](#prepare) + - [query](#query) + - [real_query](#real_query) + - [refresh](#refresh) + - [reset](#reset) + - [select](#select) + - [select_db](#select_db) + - [set_option](#set_option) + - [tables](#tables) + - [update](#update) + - [use_result](#use_result) +- [Field](#Field) + - [str](#str) +- [Result](#Result) + - [fetch_row](#fetch_row) + - [n_rows](#n_rows) + - [n_fields](#n_fields) + - [rows](#rows) + - [maps](#maps) + - [fields](#fields) + - [free](#free) +- [Row](#Row) +- [Stmt](#Stmt) + - [str](#str) + - [prepare](#prepare) + - [bind_params](#bind_params) + - [execute](#execute) + - [next](#next) + - [gen_metadata](#gen_metadata) + - [fetch_fields](#fetch_fields) + - [fetch_stmt](#fetch_stmt) + - [close](#close) + - [error](#error) + - [bind_bool](#bind_bool) + - [bind_byte](#bind_byte) + - [bind_u8](#bind_u8) + - [bind_i8](#bind_i8) + - [bind_i16](#bind_i16) + - [bind_u16](#bind_u16) + - [bind_int](#bind_int) + - [bind_u32](#bind_u32) + - [bind_i64](#bind_i64) + - [bind_u64](#bind_u64) + - [bind_f32](#bind_f32) + - [bind_f64](#bind_f64) + - [bind_text](#bind_text) + - [bind_null](#bind_null) + - [bind](#bind) + - [bind_res](#bind_res) + - [bind_result_buffer](#bind_result_buffer) + - [store_result](#store_result) + - [fetch_column](#fetch_column) +- [StmtHandle](#StmtHandle) + - [execute](#execute) + - [close](#close) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## connect +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## get_client_info +[[Return to contents]](#Contents) + +## get_client_version +[[Return to contents]](#Contents) + +## ConnectionFlag +[[Return to contents]](#Contents) + +## FieldType +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## get_len +[[Return to contents]](#Contents) + +## C.MYSQL +[[Return to contents]](#Contents) + +## C.MYSQL_BIND +[[Return to contents]](#Contents) + +## C.MYSQL_FIELD +[[Return to contents]](#Contents) + +## C.MYSQL_RES +[[Return to contents]](#Contents) + +## C.MYSQL_STMT +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## DB +[[Return to contents]](#Contents) + +## affected_rows +[[Return to contents]](#Contents) + +## autocommit +[[Return to contents]](#Contents) + +## change_user +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## commit +[[Return to contents]](#Contents) + +## create +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## drop +[[Return to contents]](#Contents) + +## dump_debug_info +[[Return to contents]](#Contents) + +## escape_string +[[Return to contents]](#Contents) + +## exec +[[Return to contents]](#Contents) + +## exec_none +[[Return to contents]](#Contents) + +## exec_one +[[Return to contents]](#Contents) + +## exec_param +[[Return to contents]](#Contents) + +## exec_param_many +[[Return to contents]](#Contents) + +## get_host_info +[[Return to contents]](#Contents) + +## get_option +[[Return to contents]](#Contents) + +## get_server_info +[[Return to contents]](#Contents) + +## get_server_version +[[Return to contents]](#Contents) + +## info +[[Return to contents]](#Contents) + +## init_stmt +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## last_id +[[Return to contents]](#Contents) + +## ping +[[Return to contents]](#Contents) + +## prepare +[[Return to contents]](#Contents) + +## query +[[Return to contents]](#Contents) + +## real_query +[[Return to contents]](#Contents) + +## refresh +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## select +[[Return to contents]](#Contents) + +## select_db +[[Return to contents]](#Contents) + +## set_option +[[Return to contents]](#Contents) + +## tables +[[Return to contents]](#Contents) + +## update +[[Return to contents]](#Contents) + +## use_result +[[Return to contents]](#Contents) + +## Field +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Result +[[Return to contents]](#Contents) + +## fetch_row +[[Return to contents]](#Contents) + +## n_rows +[[Return to contents]](#Contents) + +## n_fields +[[Return to contents]](#Contents) + +## rows +[[Return to contents]](#Contents) + +## maps +[[Return to contents]](#Contents) + +## fields +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## Row +[[Return to contents]](#Contents) + +## Stmt +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## prepare +[[Return to contents]](#Contents) + +## bind_params +[[Return to contents]](#Contents) + +## execute +[[Return to contents]](#Contents) + +## next +[[Return to contents]](#Contents) + +## gen_metadata +[[Return to contents]](#Contents) + +## fetch_fields +[[Return to contents]](#Contents) + +## fetch_stmt +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## bind_bool +[[Return to contents]](#Contents) + +## bind_byte +[[Return to contents]](#Contents) + +## bind_u8 +[[Return to contents]](#Contents) + +## bind_i8 +[[Return to contents]](#Contents) + +## bind_i16 +[[Return to contents]](#Contents) + +## bind_u16 +[[Return to contents]](#Contents) + +## bind_int +[[Return to contents]](#Contents) + +## bind_u32 +[[Return to contents]](#Contents) + +## bind_i64 +[[Return to contents]](#Contents) + +## bind_u64 +[[Return to contents]](#Contents) + +## bind_f32 +[[Return to contents]](#Contents) + +## bind_f64 +[[Return to contents]](#Contents) + +## bind_text +[[Return to contents]](#Contents) + +## bind_null +[[Return to contents]](#Contents) + +## bind +[[Return to contents]](#Contents) + +## bind_res +[[Return to contents]](#Contents) + +## bind_result_buffer +[[Return to contents]](#Contents) + +## store_result +[[Return to contents]](#Contents) + +## fetch_column +[[Return to contents]](#Contents) + +## StmtHandle +[[Return to contents]](#Contents) + +## execute +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/db.pg.md b/vdocs/db.pg.md new file mode 100644 index 00000000..7c2604e3 --- /dev/null +++ b/vdocs/db.pg.md @@ -0,0 +1,130 @@ +# module db.pg + + +## Contents +- [connect](#connect) +- [connect_with_conninfo](#connect_with_conninfo) +- [ConnStatusType](#ConnStatusType) +- [ExecStatusType](#ExecStatusType) +- [Oid](#Oid) +- [C.PGconn](#C.PGconn) +- [C.PGresult](#C.PGresult) +- [C.pg_conn](#C.pg_conn) +- [C.pg_result](#C.pg_result) +- [Config](#Config) +- [DB](#DB) + - [close](#close) + - [copy_expert](#copy_expert) + - [create](#create) + - [delete](#delete) + - [drop](#drop) + - [exec](#exec) + - [exec_one](#exec_one) + - [exec_param](#exec_param) + - [exec_param2](#exec_param2) + - [exec_param_many](#exec_param_many) + - [exec_prepared](#exec_prepared) + - [insert](#insert) + - [last_id](#last_id) + - [prepare](#prepare) + - [q_int](#q_int) + - [q_string](#q_string) + - [q_strings](#q_strings) + - [select](#select) + - [update](#update) +- [Row](#Row) + +## connect +[[Return to contents]](#Contents) + +## connect_with_conninfo +[[Return to contents]](#Contents) + +## ConnStatusType +[[Return to contents]](#Contents) + +## ExecStatusType +[[Return to contents]](#Contents) + +## Oid +[[Return to contents]](#Contents) + +## C.PGconn +[[Return to contents]](#Contents) + +## C.PGresult +[[Return to contents]](#Contents) + +## C.pg_conn +[[Return to contents]](#Contents) + +## C.pg_result +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## DB +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## copy_expert +[[Return to contents]](#Contents) + +## create +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## drop +[[Return to contents]](#Contents) + +## exec +[[Return to contents]](#Contents) + +## exec_one +[[Return to contents]](#Contents) + +## exec_param +[[Return to contents]](#Contents) + +## exec_param2 +[[Return to contents]](#Contents) + +## exec_param_many +[[Return to contents]](#Contents) + +## exec_prepared +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## last_id +[[Return to contents]](#Contents) + +## prepare +[[Return to contents]](#Contents) + +## q_int +[[Return to contents]](#Contents) + +## q_string +[[Return to contents]](#Contents) + +## q_strings +[[Return to contents]](#Contents) + +## select +[[Return to contents]](#Contents) + +## update +[[Return to contents]](#Contents) + +## Row +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/db.sqlite.md b/vdocs/db.sqlite.md new file mode 100644 index 00000000..78c867f2 --- /dev/null +++ b/vdocs/db.sqlite.md @@ -0,0 +1,234 @@ +# module db.sqlite + + +## Contents +- [Constants](#Constants) +- [connect](#connect) +- [connect_full](#connect_full) +- [get_default_vfs](#get_default_vfs) +- [get_vfs](#get_vfs) +- [is_error](#is_error) +- [Sqlite3_file](#Sqlite3_file) +- [Sqlite3_io_methods](#Sqlite3_io_methods) +- [Sqlite3_vfs](#Sqlite3_vfs) + - [register_as_nondefault](#register_as_nondefault) + - [unregister](#unregister) +- [JournalMode](#JournalMode) +- [OpenModeFlag](#OpenModeFlag) +- [Result](#Result) + - [is_error](#is_error) +- [SyncMode](#SyncMode) +- [C.sqlite3](#C.sqlite3) +- [C.sqlite3_file](#C.sqlite3_file) +- [C.sqlite3_io_methods](#C.sqlite3_io_methods) +- [C.sqlite3_stmt](#C.sqlite3_stmt) +- [C.sqlite3_vfs](#C.sqlite3_vfs) +- [DB](#DB) + - [busy_timeout](#busy_timeout) + - [close](#close) + - [create](#create) + - [create_table](#create_table) + - [delete](#delete) + - [drop](#drop) + - [error_message](#error_message) + - [exec](#exec) + - [exec_map](#exec_map) + - [exec_none](#exec_none) + - [exec_one](#exec_one) + - [exec_param](#exec_param) + - [exec_param_many](#exec_param_many) + - [get_affected_rows_count](#get_affected_rows_count) + - [insert](#insert) + - [journal_mode](#journal_mode) + - [last_id](#last_id) + - [last_insert_rowid](#last_insert_rowid) + - [q_int](#q_int) + - [q_string](#q_string) + - [select](#select) + - [str](#str) + - [synchronization_mode](#synchronization_mode) + - [update](#update) +- [Row](#Row) +- [Stmt](#Stmt) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## connect +[[Return to contents]](#Contents) + +## connect_full +[[Return to contents]](#Contents) + +## get_default_vfs +[[Return to contents]](#Contents) + +## get_vfs +[[Return to contents]](#Contents) + +## is_error +[[Return to contents]](#Contents) + +## Sqlite3_file +[[Return to contents]](#Contents) + +## Sqlite3_io_methods +[[Return to contents]](#Contents) + +## Sqlite3_vfs +[[Return to contents]](#Contents) + +## register_as_nondefault +[[Return to contents]](#Contents) + +## unregister +[[Return to contents]](#Contents) + +## JournalMode +[[Return to contents]](#Contents) + +## OpenModeFlag +[[Return to contents]](#Contents) + +## Result +[[Return to contents]](#Contents) + +## is_error +[[Return to contents]](#Contents) + +## SyncMode +[[Return to contents]](#Contents) + +## C.sqlite3 +[[Return to contents]](#Contents) + +## C.sqlite3_file +[[Return to contents]](#Contents) + +## C.sqlite3_io_methods +[[Return to contents]](#Contents) + +## C.sqlite3_stmt +[[Return to contents]](#Contents) + +## C.sqlite3_vfs +[[Return to contents]](#Contents) + +## DB +[[Return to contents]](#Contents) + +## busy_timeout +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## create +[[Return to contents]](#Contents) + +## create_table +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## drop +[[Return to contents]](#Contents) + +## error_message +[[Return to contents]](#Contents) + +## exec +[[Return to contents]](#Contents) + +## exec_map +[[Return to contents]](#Contents) + +## exec_none +[[Return to contents]](#Contents) + +## exec_one +[[Return to contents]](#Contents) + +## exec_param +[[Return to contents]](#Contents) + +## exec_param_many +[[Return to contents]](#Contents) + +## get_affected_rows_count +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## journal_mode +[[Return to contents]](#Contents) + +## last_id +[[Return to contents]](#Contents) + +## last_insert_rowid +[[Return to contents]](#Contents) + +## q_int +[[Return to contents]](#Contents) + +## q_string +[[Return to contents]](#Contents) + +## select +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## synchronization_mode +[[Return to contents]](#Contents) + +## update +[[Return to contents]](#Contents) + +## Row +[[Return to contents]](#Contents) + +## Stmt +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/dl.loader.md b/vdocs/dl.loader.md new file mode 100644 index 00000000..f1f6c840 --- /dev/null +++ b/vdocs/dl.loader.md @@ -0,0 +1,60 @@ +# module dl.loader + + +## Contents +- [Constants](#Constants) +- [get_or_create_dynamic_lib_loader](#get_or_create_dynamic_lib_loader) +- [registered_dl_loader_keys](#registered_dl_loader_keys) +- [DynamicLibLoader](#DynamicLibLoader) + - [open](#open) + - [close](#close) + - [get_sym](#get_sym) + - [unregister](#unregister) +- [DynamicLibLoaderConfig](#DynamicLibLoaderConfig) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## get_or_create_dynamic_lib_loader +[[Return to contents]](#Contents) + +## registered_dl_loader_keys +[[Return to contents]](#Contents) + +## DynamicLibLoader +[[Return to contents]](#Contents) + +## open +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## get_sym +[[Return to contents]](#Contents) + +## unregister +[[Return to contents]](#Contents) + +## DynamicLibLoaderConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/dl.md b/vdocs/dl.md new file mode 100644 index 00000000..fa6f3bc7 --- /dev/null +++ b/vdocs/dl.md @@ -0,0 +1,58 @@ +# module dl + + +## Contents +- [Constants](#Constants) +- [close](#close) +- [dlerror](#dlerror) +- [get_libname](#get_libname) +- [get_shared_library_extension](#get_shared_library_extension) +- [open](#open) +- [open_opt](#open_opt) +- [sym](#sym) +- [sym_opt](#sym_opt) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## dlerror +[[Return to contents]](#Contents) + +## get_libname +[[Return to contents]](#Contents) + +## get_shared_library_extension +[[Return to contents]](#Contents) + +## open +[[Return to contents]](#Contents) + +## open_opt +[[Return to contents]](#Contents) + +## sym +[[Return to contents]](#Contents) + +## sym_opt +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/dlmalloc.md b/vdocs/dlmalloc.md new file mode 100644 index 00000000..291a854c --- /dev/null +++ b/vdocs/dlmalloc.md @@ -0,0 +1,86 @@ +# module dlmalloc + + +## Contents +- [Constants](#Constants) +- [calloc](#calloc) +- [free](#free) +- [get_system_allocator](#get_system_allocator) +- [malloc](#malloc) +- [memalign](#memalign) +- [new](#new) +- [realloc](#realloc) +- [Map_flags](#Map_flags) +- [Mm_prot](#Mm_prot) +- [Allocator](#Allocator) +- [Dlmalloc](#Dlmalloc) + - [calloc_must_clear](#calloc_must_clear) + - [calloc](#calloc) + - [free_](#free_) + - [malloc](#malloc) + - [realloc](#realloc) + - [memalign](#memalign) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## calloc +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## get_system_allocator +[[Return to contents]](#Contents) + +## malloc +[[Return to contents]](#Contents) + +## memalign +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## realloc +[[Return to contents]](#Contents) + +## Map_flags +[[Return to contents]](#Contents) + +## Mm_prot +[[Return to contents]](#Contents) + +## Allocator +[[Return to contents]](#Contents) + +## Dlmalloc +[[Return to contents]](#Contents) + +## calloc_must_clear +[[Return to contents]](#Contents) + +## calloc +[[Return to contents]](#Contents) + +## free_ +[[Return to contents]](#Contents) + +## malloc +[[Return to contents]](#Contents) + +## realloc +[[Return to contents]](#Contents) + +## memalign +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.base32.md b/vdocs/encoding.base32.md new file mode 100644 index 00000000..4bff09e3 --- /dev/null +++ b/vdocs/encoding.base32.md @@ -0,0 +1,78 @@ +# module encoding.base32 + + +## Contents +- [Constants](#Constants) +- [decode](#decode) +- [decode_string_to_string](#decode_string_to_string) +- [decode_to_string](#decode_to_string) +- [encode](#encode) +- [encode_string_to_string](#encode_string_to_string) +- [encode_to_string](#encode_to_string) +- [new_encoding](#new_encoding) +- [new_encoding_with_padding](#new_encoding_with_padding) +- [new_std_encoding](#new_std_encoding) +- [new_std_encoding_with_padding](#new_std_encoding_with_padding) +- [Encoding](#Encoding) + - [encode_to_string](#encode_to_string) + - [encode_string_to_string](#encode_string_to_string) + - [decode_string](#decode_string) + - [decode_string_to_string](#decode_string_to_string) + - [decode](#decode) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +## decode_string_to_string +[[Return to contents]](#Contents) + +## decode_to_string +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## encode_string_to_string +[[Return to contents]](#Contents) + +## encode_to_string +[[Return to contents]](#Contents) + +## new_encoding +[[Return to contents]](#Contents) + +## new_encoding_with_padding +[[Return to contents]](#Contents) + +## new_std_encoding +[[Return to contents]](#Contents) + +## new_std_encoding_with_padding +[[Return to contents]](#Contents) + +## Encoding +## encode_to_string +[[Return to contents]](#Contents) + +## encode_string_to_string +[[Return to contents]](#Contents) + +## decode_string +[[Return to contents]](#Contents) + +## decode_string_to_string +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.base58.md b/vdocs/encoding.base58.md new file mode 100644 index 00000000..c7209ec7 --- /dev/null +++ b/vdocs/encoding.base58.md @@ -0,0 +1,74 @@ +# module encoding.base58 + + +## Contents +- [Constants](#Constants) +- [decode](#decode) +- [decode_bytes](#decode_bytes) +- [decode_int](#decode_int) +- [decode_int_walpha](#decode_int_walpha) +- [decode_walpha](#decode_walpha) +- [decode_walpha_bytes](#decode_walpha_bytes) +- [encode](#encode) +- [encode_bytes](#encode_bytes) +- [encode_int](#encode_int) +- [encode_int_walpha](#encode_int_walpha) +- [encode_walpha](#encode_walpha) +- [encode_walpha_bytes](#encode_walpha_bytes) +- [new_alphabet](#new_alphabet) +- [Alphabet](#Alphabet) + - [str](#str) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +## decode_bytes +[[Return to contents]](#Contents) + +## decode_int +[[Return to contents]](#Contents) + +## decode_int_walpha +[[Return to contents]](#Contents) + +## decode_walpha +[[Return to contents]](#Contents) + +## decode_walpha_bytes +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## encode_bytes +[[Return to contents]](#Contents) + +## encode_int +[[Return to contents]](#Contents) + +## encode_int_walpha +[[Return to contents]](#Contents) + +## encode_walpha +[[Return to contents]](#Contents) + +## encode_walpha_bytes +[[Return to contents]](#Contents) + +## new_alphabet +[[Return to contents]](#Contents) + +## Alphabet +## str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.base64.md b/vdocs/encoding.base64.md new file mode 100644 index 00000000..fd2d6f40 --- /dev/null +++ b/vdocs/encoding.base64.md @@ -0,0 +1,64 @@ +# module encoding.base64 + + +## Contents +- [decode](#decode) +- [decode_in_buffer](#decode_in_buffer) +- [decode_in_buffer_bytes](#decode_in_buffer_bytes) +- [decode_str](#decode_str) +- [encode](#encode) +- [encode_in_buffer](#encode_in_buffer) +- [encode_str](#encode_str) +- [url_decode](#url_decode) +- [url_decode_str](#url_decode_str) +- [url_encode](#url_encode) +- [url_encode_str](#url_encode_str) + +## decode +Example +```v + +assert base64.decode('ViBpbiBiYXNlIDY0') == 'V in base 64' + +``` + +[[Return to contents]](#Contents) + +## decode_in_buffer +[[Return to contents]](#Contents) + +## decode_in_buffer_bytes +[[Return to contents]](#Contents) + +## decode_str +[[Return to contents]](#Contents) + +## encode +Example +```v + +assert base64.encode('V in base 64') == 'ViBpbiBiYXNlIDY0' + +``` + +[[Return to contents]](#Contents) + +## encode_in_buffer +[[Return to contents]](#Contents) + +## encode_str +[[Return to contents]](#Contents) + +## url_decode +[[Return to contents]](#Contents) + +## url_decode_str +[[Return to contents]](#Contents) + +## url_encode +[[Return to contents]](#Contents) + +## url_encode_str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.binary.md b/vdocs/encoding.binary.md new file mode 100644 index 00000000..2d6644a1 --- /dev/null +++ b/vdocs/encoding.binary.md @@ -0,0 +1,226 @@ +# module encoding.binary + + +## Contents +- [big_endian_get_u16](#big_endian_get_u16) +- [big_endian_get_u32](#big_endian_get_u32) +- [big_endian_get_u64](#big_endian_get_u64) +- [big_endian_put_u16](#big_endian_put_u16) +- [big_endian_put_u16_at](#big_endian_put_u16_at) +- [big_endian_put_u16_end](#big_endian_put_u16_end) +- [big_endian_put_u16_fixed](#big_endian_put_u16_fixed) +- [big_endian_put_u32](#big_endian_put_u32) +- [big_endian_put_u32_at](#big_endian_put_u32_at) +- [big_endian_put_u32_end](#big_endian_put_u32_end) +- [big_endian_put_u32_fixed](#big_endian_put_u32_fixed) +- [big_endian_put_u64](#big_endian_put_u64) +- [big_endian_put_u64_at](#big_endian_put_u64_at) +- [big_endian_put_u64_end](#big_endian_put_u64_end) +- [big_endian_put_u64_fixed](#big_endian_put_u64_fixed) +- [big_endian_u16](#big_endian_u16) +- [big_endian_u16_at](#big_endian_u16_at) +- [big_endian_u16_end](#big_endian_u16_end) +- [big_endian_u16_fixed](#big_endian_u16_fixed) +- [big_endian_u32](#big_endian_u32) +- [big_endian_u32_at](#big_endian_u32_at) +- [big_endian_u32_end](#big_endian_u32_end) +- [big_endian_u32_fixed](#big_endian_u32_fixed) +- [big_endian_u64](#big_endian_u64) +- [big_endian_u64_at](#big_endian_u64_at) +- [big_endian_u64_end](#big_endian_u64_end) +- [big_endian_u64_fixed](#big_endian_u64_fixed) +- [little_endian_f32_at](#little_endian_f32_at) +- [little_endian_get_u16](#little_endian_get_u16) +- [little_endian_get_u32](#little_endian_get_u32) +- [little_endian_get_u64](#little_endian_get_u64) +- [little_endian_put_u16](#little_endian_put_u16) +- [little_endian_put_u16_at](#little_endian_put_u16_at) +- [little_endian_put_u16_end](#little_endian_put_u16_end) +- [little_endian_put_u16_fixed](#little_endian_put_u16_fixed) +- [little_endian_put_u32](#little_endian_put_u32) +- [little_endian_put_u32_at](#little_endian_put_u32_at) +- [little_endian_put_u32_end](#little_endian_put_u32_end) +- [little_endian_put_u32_fixed](#little_endian_put_u32_fixed) +- [little_endian_put_u64](#little_endian_put_u64) +- [little_endian_put_u64_at](#little_endian_put_u64_at) +- [little_endian_put_u64_end](#little_endian_put_u64_end) +- [little_endian_put_u64_fixed](#little_endian_put_u64_fixed) +- [little_endian_u16](#little_endian_u16) +- [little_endian_u16_at](#little_endian_u16_at) +- [little_endian_u16_end](#little_endian_u16_end) +- [little_endian_u16_fixed](#little_endian_u16_fixed) +- [little_endian_u32](#little_endian_u32) +- [little_endian_u32_at](#little_endian_u32_at) +- [little_endian_u32_end](#little_endian_u32_end) +- [little_endian_u32_fixed](#little_endian_u32_fixed) +- [little_endian_u64](#little_endian_u64) +- [little_endian_u64_at](#little_endian_u64_at) +- [little_endian_u64_end](#little_endian_u64_end) +- [little_endian_u64_fixed](#little_endian_u64_fixed) + +## big_endian_get_u16 +[[Return to contents]](#Contents) + +## big_endian_get_u32 +[[Return to contents]](#Contents) + +## big_endian_get_u64 +[[Return to contents]](#Contents) + +## big_endian_put_u16 +[[Return to contents]](#Contents) + +## big_endian_put_u16_at +[[Return to contents]](#Contents) + +## big_endian_put_u16_end +[[Return to contents]](#Contents) + +## big_endian_put_u16_fixed +[[Return to contents]](#Contents) + +## big_endian_put_u32 +[[Return to contents]](#Contents) + +## big_endian_put_u32_at +[[Return to contents]](#Contents) + +## big_endian_put_u32_end +[[Return to contents]](#Contents) + +## big_endian_put_u32_fixed +[[Return to contents]](#Contents) + +## big_endian_put_u64 +[[Return to contents]](#Contents) + +## big_endian_put_u64_at +[[Return to contents]](#Contents) + +## big_endian_put_u64_end +[[Return to contents]](#Contents) + +## big_endian_put_u64_fixed +[[Return to contents]](#Contents) + +## big_endian_u16 +[[Return to contents]](#Contents) + +## big_endian_u16_at +[[Return to contents]](#Contents) + +## big_endian_u16_end +[[Return to contents]](#Contents) + +## big_endian_u16_fixed +[[Return to contents]](#Contents) + +## big_endian_u32 +[[Return to contents]](#Contents) + +## big_endian_u32_at +[[Return to contents]](#Contents) + +## big_endian_u32_end +[[Return to contents]](#Contents) + +## big_endian_u32_fixed +[[Return to contents]](#Contents) + +## big_endian_u64 +[[Return to contents]](#Contents) + +## big_endian_u64_at +[[Return to contents]](#Contents) + +## big_endian_u64_end +[[Return to contents]](#Contents) + +## big_endian_u64_fixed +[[Return to contents]](#Contents) + +## little_endian_f32_at +[[Return to contents]](#Contents) + +## little_endian_get_u16 +[[Return to contents]](#Contents) + +## little_endian_get_u32 +[[Return to contents]](#Contents) + +## little_endian_get_u64 +[[Return to contents]](#Contents) + +## little_endian_put_u16 +[[Return to contents]](#Contents) + +## little_endian_put_u16_at +[[Return to contents]](#Contents) + +## little_endian_put_u16_end +[[Return to contents]](#Contents) + +## little_endian_put_u16_fixed +[[Return to contents]](#Contents) + +## little_endian_put_u32 +[[Return to contents]](#Contents) + +## little_endian_put_u32_at +[[Return to contents]](#Contents) + +## little_endian_put_u32_end +[[Return to contents]](#Contents) + +## little_endian_put_u32_fixed +[[Return to contents]](#Contents) + +## little_endian_put_u64 +[[Return to contents]](#Contents) + +## little_endian_put_u64_at +[[Return to contents]](#Contents) + +## little_endian_put_u64_end +[[Return to contents]](#Contents) + +## little_endian_put_u64_fixed +[[Return to contents]](#Contents) + +## little_endian_u16 +[[Return to contents]](#Contents) + +## little_endian_u16_at +[[Return to contents]](#Contents) + +## little_endian_u16_end +[[Return to contents]](#Contents) + +## little_endian_u16_fixed +[[Return to contents]](#Contents) + +## little_endian_u32 +[[Return to contents]](#Contents) + +## little_endian_u32_at +[[Return to contents]](#Contents) + +## little_endian_u32_end +[[Return to contents]](#Contents) + +## little_endian_u32_fixed +[[Return to contents]](#Contents) + +## little_endian_u64 +[[Return to contents]](#Contents) + +## little_endian_u64_at +[[Return to contents]](#Contents) + +## little_endian_u64_end +[[Return to contents]](#Contents) + +## little_endian_u64_fixed +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.csv.md b/vdocs/encoding.csv.md new file mode 100644 index 00000000..88e30872 --- /dev/null +++ b/vdocs/encoding.csv.md @@ -0,0 +1,144 @@ +# module encoding.csv + + +## Contents +- [Constants](#Constants) +- [csv_reader](#csv_reader) +- [csv_reader_from_string](#csv_reader_from_string) +- [csv_sequential_reader](#csv_sequential_reader) +- [decode](#decode) +- [new_reader](#new_reader) +- [new_reader_from_file](#new_reader_from_file) +- [new_writer](#new_writer) +- [CellValue](#CellValue) +- [Reader](#Reader) + - [read](#read) +- [Writer](#Writer) + - [write](#write) + - [str](#str) +- [ColumType](#ColumType) +- [GetCellConfig](#GetCellConfig) +- [GetHeaderConf](#GetHeaderConf) +- [HeaderItem](#HeaderItem) +- [RandomAccessReader](#RandomAccessReader) + - [dispose_csv_reader](#dispose_csv_reader) + - [map_csv](#map_csv) + - [get_row](#get_row) + - [get_cell](#get_cell) + - [get_cellt](#get_cellt) + - [build_header_dict](#build_header_dict) + - [rows_count](#rows_count) +- [RandomAccessReaderConfig](#RandomAccessReaderConfig) +- [ReaderConfig](#ReaderConfig) +- [SequentialReader](#SequentialReader) + - [dispose_csv_reader](#dispose_csv_reader) + - [has_data](#has_data) + - [get_next_row](#get_next_row) +- [SequentialReaderConfig](#SequentialReaderConfig) +- [WriterConfig](#WriterConfig) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## csv_reader +[[Return to contents]](#Contents) + +## csv_reader_from_string +[[Return to contents]](#Contents) + +## csv_sequential_reader +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +## new_reader +[[Return to contents]](#Contents) + +## new_reader_from_file +[[Return to contents]](#Contents) + +## new_writer +[[Return to contents]](#Contents) + +## CellValue +[[Return to contents]](#Contents) + +## Reader +## read +[[Return to contents]](#Contents) + +## Writer +## write +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ColumType +[[Return to contents]](#Contents) + +## GetCellConfig +[[Return to contents]](#Contents) + +## GetHeaderConf +[[Return to contents]](#Contents) + +## HeaderItem +[[Return to contents]](#Contents) + +## RandomAccessReader +[[Return to contents]](#Contents) + +## dispose_csv_reader +[[Return to contents]](#Contents) + +## map_csv +[[Return to contents]](#Contents) + +## get_row +[[Return to contents]](#Contents) + +## get_cell +[[Return to contents]](#Contents) + +## get_cellt +[[Return to contents]](#Contents) + +## build_header_dict +[[Return to contents]](#Contents) + +## rows_count +[[Return to contents]](#Contents) + +## RandomAccessReaderConfig +[[Return to contents]](#Contents) + +## ReaderConfig +[[Return to contents]](#Contents) + +## SequentialReader +[[Return to contents]](#Contents) + +## dispose_csv_reader +[[Return to contents]](#Contents) + +## has_data +[[Return to contents]](#Contents) + +## get_next_row +[[Return to contents]](#Contents) + +## SequentialReaderConfig +[[Return to contents]](#Contents) + +## WriterConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.hex.md b/vdocs/encoding.hex.md new file mode 100644 index 00000000..bc8e8fa6 --- /dev/null +++ b/vdocs/encoding.hex.md @@ -0,0 +1,14 @@ +# module encoding.hex + + +## Contents +- [decode](#decode) +- [encode](#encode) + +## decode +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.html.md b/vdocs/encoding.html.md new file mode 100644 index 00000000..228107f6 --- /dev/null +++ b/vdocs/encoding.html.md @@ -0,0 +1,22 @@ +# module encoding.html + + +## Contents +- [escape](#escape) +- [unescape](#unescape) +- [EscapeConfig](#EscapeConfig) +- [UnescapeConfig](#UnescapeConfig) + +## escape +[[Return to contents]](#Contents) + +## unescape +[[Return to contents]](#Contents) + +## EscapeConfig +[[Return to contents]](#Contents) + +## UnescapeConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.iconv.md b/vdocs/encoding.iconv.md new file mode 100644 index 00000000..f9e365dd --- /dev/null +++ b/vdocs/encoding.iconv.md @@ -0,0 +1,30 @@ +# module encoding.iconv + + +## Contents +- [create_utf_string_with_bom](#create_utf_string_with_bom) +- [encoding_to_vstring](#encoding_to_vstring) +- [read_file_encoding](#read_file_encoding) +- [remove_utf_string_with_bom](#remove_utf_string_with_bom) +- [vstring_to_encoding](#vstring_to_encoding) +- [write_file_encoding](#write_file_encoding) + +## create_utf_string_with_bom +[[Return to contents]](#Contents) + +## encoding_to_vstring +[[Return to contents]](#Contents) + +## read_file_encoding +[[Return to contents]](#Contents) + +## remove_utf_string_with_bom +[[Return to contents]](#Contents) + +## vstring_to_encoding +[[Return to contents]](#Contents) + +## write_file_encoding +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.leb128.md b/vdocs/encoding.leb128.md new file mode 100644 index 00000000..b632de62 --- /dev/null +++ b/vdocs/encoding.leb128.md @@ -0,0 +1,38 @@ +# module encoding.leb128 + + +## Contents +- [decode_i32](#decode_i32) +- [decode_i64](#decode_i64) +- [decode_u32](#decode_u32) +- [decode_u64](#decode_u64) +- [encode_i32](#encode_i32) +- [encode_i64](#encode_i64) +- [encode_u32](#encode_u32) +- [encode_u64](#encode_u64) + +## decode_i32 +[[Return to contents]](#Contents) + +## decode_i64 +[[Return to contents]](#Contents) + +## decode_u32 +[[Return to contents]](#Contents) + +## decode_u64 +[[Return to contents]](#Contents) + +## encode_i32 +[[Return to contents]](#Contents) + +## encode_i64 +[[Return to contents]](#Contents) + +## encode_u32 +[[Return to contents]](#Contents) + +## encode_u64 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.txtar.md b/vdocs/encoding.txtar.md new file mode 100644 index 00000000..c25d836e --- /dev/null +++ b/vdocs/encoding.txtar.md @@ -0,0 +1,38 @@ +# module encoding.txtar + + +## Contents +- [pack](#pack) +- [parse](#parse) +- [parse_file](#parse_file) +- [unpack](#unpack) +- [Archive](#Archive) + - [str](#str) + - [unpack_to](#unpack_to) +- [File](#File) + +## pack +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## parse_file +[[Return to contents]](#Contents) + +## unpack +[[Return to contents]](#Contents) + +## Archive +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## unpack_to +[[Return to contents]](#Contents) + +## File +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.utf8.east_asian.md b/vdocs/encoding.utf8.east_asian.md new file mode 100644 index 00000000..54a4fd8b --- /dev/null +++ b/vdocs/encoding.utf8.east_asian.md @@ -0,0 +1,18 @@ +# module encoding.utf8.east_asian + + +## Contents +- [display_width](#display_width) +- [east_asian_width_property_at](#east_asian_width_property_at) +- [EastAsianWidthProperty](#EastAsianWidthProperty) + +## display_width +[[Return to contents]](#Contents) + +## east_asian_width_property_at +[[Return to contents]](#Contents) + +## EastAsianWidthProperty +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.utf8.md b/vdocs/encoding.utf8.md new file mode 100644 index 00000000..1cb91458 --- /dev/null +++ b/vdocs/encoding.utf8.md @@ -0,0 +1,82 @@ +# module encoding.utf8 + + +## Contents +- [get_rune](#get_rune) +- [get_uchar](#get_uchar) +- [is_control](#is_control) +- [is_global_punct](#is_global_punct) +- [is_letter](#is_letter) +- [is_number](#is_number) +- [is_punct](#is_punct) +- [is_rune_global_punct](#is_rune_global_punct) +- [is_rune_punct](#is_rune_punct) +- [is_space](#is_space) +- [is_uchar_global_punct](#is_uchar_global_punct) +- [is_uchar_punct](#is_uchar_punct) +- [len](#len) +- [raw_index](#raw_index) +- [reverse](#reverse) +- [to_lower](#to_lower) +- [to_upper](#to_upper) +- [validate](#validate) +- [validate_str](#validate_str) + +## get_rune +[[Return to contents]](#Contents) + +## get_uchar +[[Return to contents]](#Contents) + +## is_control +[[Return to contents]](#Contents) + +## is_global_punct +[[Return to contents]](#Contents) + +## is_letter +[[Return to contents]](#Contents) + +## is_number +[[Return to contents]](#Contents) + +## is_punct +[[Return to contents]](#Contents) + +## is_rune_global_punct +[[Return to contents]](#Contents) + +## is_rune_punct +[[Return to contents]](#Contents) + +## is_space +[[Return to contents]](#Contents) + +## is_uchar_global_punct +[[Return to contents]](#Contents) + +## is_uchar_punct +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## raw_index +[[Return to contents]](#Contents) + +## reverse +[[Return to contents]](#Contents) + +## to_lower +[[Return to contents]](#Contents) + +## to_upper +[[Return to contents]](#Contents) + +## validate +[[Return to contents]](#Contents) + +## validate_str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/encoding.xml.md b/vdocs/encoding.xml.md new file mode 100644 index 00000000..8a5301d8 --- /dev/null +++ b/vdocs/encoding.xml.md @@ -0,0 +1,124 @@ +# module encoding.xml + + +## Contents +- [Constants](#Constants) +- [escape_text](#escape_text) +- [parse_single_node](#parse_single_node) +- [unescape_text](#unescape_text) +- [XMLDocument.from_file](#XMLDocument.from_file) +- [XMLDocument.from_reader](#XMLDocument.from_reader) +- [XMLDocument.from_string](#XMLDocument.from_string) +- [DTDListItem](#DTDListItem) +- [XMLNodeContents](#XMLNodeContents) +- [DTDElement](#DTDElement) +- [DTDEntity](#DTDEntity) +- [DocumentType](#DocumentType) +- [DocumentTypeDefinition](#DocumentTypeDefinition) +- [EscapeConfig](#EscapeConfig) +- [UnescapeConfig](#UnescapeConfig) +- [XMLCData](#XMLCData) +- [XMLComment](#XMLComment) +- [XMLDocument](#XMLDocument) + - [get_element_by_id](#get_element_by_id) + - [get_elements_by_attribute](#get_elements_by_attribute) + - [get_elements_by_tag](#get_elements_by_tag) + - [pretty_str](#pretty_str) + - [str](#str) + - [validate](#validate) +- [XMLNode](#XMLNode) + - [get_element_by_id](#get_element_by_id) + - [get_elements_by_attribute](#get_elements_by_attribute) + - [get_elements_by_tag](#get_elements_by_tag) + - [pretty_str](#pretty_str) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## escape_text +[[Return to contents]](#Contents) + +## parse_single_node +[[Return to contents]](#Contents) + +## unescape_text +[[Return to contents]](#Contents) + +## XMLDocument.from_file +[[Return to contents]](#Contents) + +## XMLDocument.from_reader +[[Return to contents]](#Contents) + +## XMLDocument.from_string +[[Return to contents]](#Contents) + +## DTDListItem +[[Return to contents]](#Contents) + +## XMLNodeContents +[[Return to contents]](#Contents) + +## DTDElement +[[Return to contents]](#Contents) + +## DTDEntity +[[Return to contents]](#Contents) + +## DocumentType +[[Return to contents]](#Contents) + +## DocumentTypeDefinition +[[Return to contents]](#Contents) + +## EscapeConfig +[[Return to contents]](#Contents) + +## UnescapeConfig +[[Return to contents]](#Contents) + +## XMLCData +[[Return to contents]](#Contents) + +## XMLComment +[[Return to contents]](#Contents) + +## XMLDocument +[[Return to contents]](#Contents) + +## get_element_by_id +[[Return to contents]](#Contents) + +## get_elements_by_attribute +[[Return to contents]](#Contents) + +## get_elements_by_tag +[[Return to contents]](#Contents) + +## pretty_str +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## validate +[[Return to contents]](#Contents) + +## XMLNode +[[Return to contents]](#Contents) + +## get_element_by_id +[[Return to contents]](#Contents) + +## get_elements_by_attribute +[[Return to contents]](#Contents) + +## get_elements_by_tag +[[Return to contents]](#Contents) + +## pretty_str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/eventbus.md b/vdocs/eventbus.md new file mode 100644 index 00000000..812f4cc3 --- /dev/null +++ b/vdocs/eventbus.md @@ -0,0 +1,78 @@ +# module eventbus + + +## Contents +- [new](#new) +- [EventBus.new](#EventBus.new) +- [EventBus[T]](#EventBus[T]) + - [publish](#publish) + - [clear_all](#clear_all) + - [has_subscriber](#has_subscriber) +- [EventHandlerFn](#EventHandlerFn) +- [Subscriber[T]](#Subscriber[T]) + - [subscribe](#subscribe) + - [subscribe_method](#subscribe_method) + - [unsubscribe_method](#unsubscribe_method) + - [unsubscribe_receiver](#unsubscribe_receiver) + - [subscribe_once](#subscribe_once) + - [is_subscribed](#is_subscribed) + - [is_subscribed_method](#is_subscribed_method) + - [unsubscribe](#unsubscribe) +- [EventBus](#EventBus) +- [Publisher](#Publisher) +- [Subscriber](#Subscriber) + +## new +[[Return to contents]](#Contents) + +## EventBus.new +[[Return to contents]](#Contents) + +## EventBus[T] +## publish +[[Return to contents]](#Contents) + +## clear_all +[[Return to contents]](#Contents) + +## has_subscriber +[[Return to contents]](#Contents) + +## EventHandlerFn +[[Return to contents]](#Contents) + +## Subscriber[T] +## subscribe +[[Return to contents]](#Contents) + +## subscribe_method +[[Return to contents]](#Contents) + +## unsubscribe_method +[[Return to contents]](#Contents) + +## unsubscribe_receiver +[[Return to contents]](#Contents) + +## subscribe_once +[[Return to contents]](#Contents) + +## is_subscribed +[[Return to contents]](#Contents) + +## is_subscribed_method +[[Return to contents]](#Contents) + +## unsubscribe +[[Return to contents]](#Contents) + +## EventBus +[[Return to contents]](#Contents) + +## Publisher +[[Return to contents]](#Contents) + +## Subscriber +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/flag.md b/vdocs/flag.md new file mode 100644 index 00000000..40f2f28a --- /dev/null +++ b/vdocs/flag.md @@ -0,0 +1,212 @@ +# module flag + + +## Contents +- [Constants](#Constants) +- [new_flag_parser](#new_flag_parser) +- [to_doc](#to_doc) +- [to_struct](#to_struct) +- [using](#using) +- [[]Flag](#[]Flag) + - [str](#str) +- [FieldHints](#FieldHints) +- [ParseMode](#ParseMode) +- [Show](#Show) +- [Style](#Style) +- [DocConfig](#DocConfig) +- [DocLayout](#DocLayout) + - [max_width](#max_width) +- [DocOptions](#DocOptions) +- [Flag](#Flag) + - [str](#str) +- [FlagConfig](#FlagConfig) +- [FlagMapper](#FlagMapper) + - [no_matches](#no_matches) + - [parse](#parse) + - [to_doc](#to_doc) + - [fields_docs](#fields_docs) + - [to_struct](#to_struct) +- [FlagParser](#FlagParser) + - [usage_example](#usage_example) + - [footer](#footer) + - [application](#application) + - [version](#version) + - [description](#description) + - [skip_executable](#skip_executable) + - [allow_unknown_args](#allow_unknown_args) + - [bool_opt](#bool_opt) + - [bool](#bool) + - [int_multi](#int_multi) + - [int_opt](#int_opt) + - [int](#int) + - [float_multi](#float_multi) + - [float_opt](#float_opt) + - [float](#float) + - [string_multi](#string_multi) + - [string_opt](#string_opt) + - [string](#string) + - [limit_free_args_to_at_least](#limit_free_args_to_at_least) + - [limit_free_args_to_exactly](#limit_free_args_to_exactly) + - [limit_free_args](#limit_free_args) + - [arguments_description](#arguments_description) + - [usage](#usage) + - [finalize](#finalize) + - [remaining_parameters](#remaining_parameters) +- [ParseConfig](#ParseConfig) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new_flag_parser +[[Return to contents]](#Contents) + +## to_doc +[[Return to contents]](#Contents) + +## to_struct +[[Return to contents]](#Contents) + +## using +[[Return to contents]](#Contents) + +## []Flag +## str +[[Return to contents]](#Contents) + +## FieldHints +[[Return to contents]](#Contents) + +## ParseMode +[[Return to contents]](#Contents) + +## Show +[[Return to contents]](#Contents) + +## Style +[[Return to contents]](#Contents) + +## DocConfig +[[Return to contents]](#Contents) + +## DocLayout +[[Return to contents]](#Contents) + +## max_width +[[Return to contents]](#Contents) + +## DocOptions +[[Return to contents]](#Contents) + +## Flag +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## FlagConfig +[[Return to contents]](#Contents) + +## FlagMapper +[[Return to contents]](#Contents) + +## no_matches +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## to_doc +[[Return to contents]](#Contents) + +## fields_docs +[[Return to contents]](#Contents) + +## to_struct +[[Return to contents]](#Contents) + +## FlagParser +[[Return to contents]](#Contents) + +## usage_example +[[Return to contents]](#Contents) + +## footer +[[Return to contents]](#Contents) + +## application +[[Return to contents]](#Contents) + +## version +[[Return to contents]](#Contents) + +## description +[[Return to contents]](#Contents) + +## skip_executable +[[Return to contents]](#Contents) + +## allow_unknown_args +[[Return to contents]](#Contents) + +## bool_opt +[[Return to contents]](#Contents) + +## bool +[[Return to contents]](#Contents) + +## int_multi +[[Return to contents]](#Contents) + +## int_opt +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## float_multi +[[Return to contents]](#Contents) + +## float_opt +[[Return to contents]](#Contents) + +## float +[[Return to contents]](#Contents) + +## string_multi +[[Return to contents]](#Contents) + +## string_opt +[[Return to contents]](#Contents) + +## string +[[Return to contents]](#Contents) + +## limit_free_args_to_at_least +[[Return to contents]](#Contents) + +## limit_free_args_to_exactly +[[Return to contents]](#Contents) + +## limit_free_args +[[Return to contents]](#Contents) + +## arguments_description +[[Return to contents]](#Contents) + +## usage +[[Return to contents]](#Contents) + +## finalize +[[Return to contents]](#Contents) + +## remaining_parameters +[[Return to contents]](#Contents) + +## ParseConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/fontstash.md b/vdocs/fontstash.md new file mode 100644 index 00000000..f2d34543 --- /dev/null +++ b/vdocs/fontstash.md @@ -0,0 +1,158 @@ +# module fontstash + + +## Contents +- [Constants](#Constants) +- [create_internal](#create_internal) +- [delete_internal](#delete_internal) +- [Context](#Context) + - [set_error_callback](#set_error_callback) + - [get_atlas_size](#get_atlas_size) + - [expand_atlas](#expand_atlas) + - [reset_atlas](#reset_atlas) + - [get_font_by_name](#get_font_by_name) + - [add_fallback_font](#add_fallback_font) + - [add_font_mem](#add_font_mem) + - [push_state](#push_state) + - [pop_state](#pop_state) + - [clear_state](#clear_state) + - [set_size](#set_size) + - [set_color](#set_color) + - [set_spacing](#set_spacing) + - [set_blur](#set_blur) + - [set_align](#set_align) + - [set_alignment](#set_alignment) + - [set_font](#set_font) + - [draw_text](#draw_text) + - [text_bounds](#text_bounds) + - [line_bounds](#line_bounds) + - [vert_metrics](#vert_metrics) + - [text_iter_init](#text_iter_init) + - [text_iter_next](#text_iter_next) + - [get_texture_data](#get_texture_data) + - [validate_texture](#validate_texture) + - [draw_debug](#draw_debug) +- [Align](#Align) +- [ErrorCode](#ErrorCode) +- [Flags](#Flags) +- [C.FONScontext](#C.FONScontext) +- [C.FONSfont](#C.FONSfont) +- [C.FONSparams](#C.FONSparams) +- [C.FONSquad](#C.FONSquad) +- [C.FONStextIter](#C.FONStextIter) + +## Constants +[[Return to contents]](#Contents) + +## create_internal +[[Return to contents]](#Contents) + +## delete_internal +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## set_error_callback +[[Return to contents]](#Contents) + +## get_atlas_size +[[Return to contents]](#Contents) + +## expand_atlas +[[Return to contents]](#Contents) + +## reset_atlas +[[Return to contents]](#Contents) + +## get_font_by_name +[[Return to contents]](#Contents) + +## add_fallback_font +[[Return to contents]](#Contents) + +## add_font_mem +[[Return to contents]](#Contents) + +## push_state +[[Return to contents]](#Contents) + +## pop_state +[[Return to contents]](#Contents) + +## clear_state +[[Return to contents]](#Contents) + +## set_size +[[Return to contents]](#Contents) + +## set_color +[[Return to contents]](#Contents) + +## set_spacing +[[Return to contents]](#Contents) + +## set_blur +[[Return to contents]](#Contents) + +## set_align +[[Return to contents]](#Contents) + +## set_alignment +[[Return to contents]](#Contents) + +## set_font +[[Return to contents]](#Contents) + +## draw_text +[[Return to contents]](#Contents) + +## text_bounds +[[Return to contents]](#Contents) + +## line_bounds +[[Return to contents]](#Contents) + +## vert_metrics +[[Return to contents]](#Contents) + +## text_iter_init +[[Return to contents]](#Contents) + +## text_iter_next +[[Return to contents]](#Contents) + +## get_texture_data +[[Return to contents]](#Contents) + +## validate_texture +[[Return to contents]](#Contents) + +## draw_debug +[[Return to contents]](#Contents) + +## Align +[[Return to contents]](#Contents) + +## ErrorCode +[[Return to contents]](#Contents) + +## Flags +[[Return to contents]](#Contents) + +## C.FONScontext +[[Return to contents]](#Contents) + +## C.FONSfont +[[Return to contents]](#Contents) + +## C.FONSparams +[[Return to contents]](#Contents) + +## C.FONSquad +[[Return to contents]](#Contents) + +## C.FONStextIter +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/gg.m4.md b/vdocs/gg.m4.md new file mode 100644 index 00000000..26351f29 --- /dev/null +++ b/vdocs/gg.m4.md @@ -0,0 +1,270 @@ +# module gg.m4 + + +## Contents +- [Constants](#Constants) +- [add](#add) +- [blank_v4](#blank_v4) +- [calc_tr_matrices](#calc_tr_matrices) +- [deg](#deg) +- [det](#det) +- [look_at](#look_at) +- [mul](#mul) +- [mul_vec](#mul_vec) +- [one_v4](#one_v4) +- [ortho](#ortho) +- [perspective](#perspective) +- [rad](#rad) +- [rotate](#rotate) +- [scale](#scale) +- [set_m4](#set_m4) +- [set_v4](#set_v4) +- [sub](#sub) +- [unit_m4](#unit_m4) +- [vec3](#vec3) +- [vec4](#vec4) +- [zero_m4](#zero_m4) +- [zero_v4](#zero_v4) +- [Mat4](#Mat4) + - [str](#str) + - [clean](#clean) + - [sum_all](#sum_all) + - [is_equal](#is_equal) + - [get_e](#get_e) + - [get_f](#get_f) + - [set_e](#set_e) + - [set_f](#set_f) + - [copy](#copy) + - [set_trace](#set_trace) + - [get_trace](#get_trace) + - [set_f32](#set_f32) + - [set_row](#set_row) + - [get_row](#get_row) + - [set_col](#set_col) + - [get_col](#get_col) + - [swap_col](#swap_col) + - [swap_row](#swap_row) + - [transpose](#transpose) + - [mul_scalar](#mul_scalar) + - [+](#+) + - [-](#-) + - [*](#*) + - [inverse](#inverse) + - [translate](#translate) +- [Vec4](#Vec4) + - [str](#str) + - [is_equal](#is_equal) + - [clean](#clean) + - [copy](#copy) + - [mul_scalar](#mul_scalar) + - [inv](#inv) + - [normalize](#normalize) + - [normalize3](#normalize3) + - [mod](#mod) + - [mod3](#mod3) + - [sum](#sum) + - [+](#+) + - [-](#-) + - [*](#*) + - [%](#%) + - [mul_vec4](#mul_vec4) + +## Constants +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## blank_v4 +[[Return to contents]](#Contents) + +## calc_tr_matrices +[[Return to contents]](#Contents) + +## deg +[[Return to contents]](#Contents) + +## det +[[Return to contents]](#Contents) + +## look_at +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## mul_vec +[[Return to contents]](#Contents) + +## one_v4 +[[Return to contents]](#Contents) + +## ortho +[[Return to contents]](#Contents) + +## perspective +[[Return to contents]](#Contents) + +## rad +[[Return to contents]](#Contents) + +## rotate +[[Return to contents]](#Contents) + +## scale +[[Return to contents]](#Contents) + +## set_m4 +[[Return to contents]](#Contents) + +## set_v4 +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## unit_m4 +[[Return to contents]](#Contents) + +## vec3 +[[Return to contents]](#Contents) + +## vec4 +[[Return to contents]](#Contents) + +## zero_m4 +[[Return to contents]](#Contents) + +## zero_v4 +[[Return to contents]](#Contents) + +## Mat4 +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## clean +[[Return to contents]](#Contents) + +## sum_all +[[Return to contents]](#Contents) + +## is_equal +[[Return to contents]](#Contents) + +## get_e +[[Return to contents]](#Contents) + +## get_f +[[Return to contents]](#Contents) + +## set_e +[[Return to contents]](#Contents) + +## set_f +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## set_trace +[[Return to contents]](#Contents) + +## get_trace +[[Return to contents]](#Contents) + +## set_f32 +[[Return to contents]](#Contents) + +## set_row +[[Return to contents]](#Contents) + +## get_row +[[Return to contents]](#Contents) + +## set_col +[[Return to contents]](#Contents) + +## get_col +[[Return to contents]](#Contents) + +## swap_col +[[Return to contents]](#Contents) + +## swap_row +[[Return to contents]](#Contents) + +## transpose +[[Return to contents]](#Contents) + +## mul_scalar +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## inverse +[[Return to contents]](#Contents) + +## translate +[[Return to contents]](#Contents) + +## Vec4 +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## is_equal +[[Return to contents]](#Contents) + +## clean +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## mul_scalar +[[Return to contents]](#Contents) + +## inv +[[Return to contents]](#Contents) + +## normalize +[[Return to contents]](#Contents) + +## normalize3 +[[Return to contents]](#Contents) + +## mod +[[Return to contents]](#Contents) + +## mod3 +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## % +[[Return to contents]](#Contents) + +## mul_vec4 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/gg.md b/vdocs/gg.md new file mode 100644 index 00000000..476814e3 --- /dev/null +++ b/vdocs/gg.md @@ -0,0 +1,476 @@ +# module gg + + +## Contents +- [create_default_pass](#create_default_pass) +- [dpi_scale](#dpi_scale) +- [high_dpi](#high_dpi) +- [is_fullscreen](#is_fullscreen) +- [new_context](#new_context) +- [screen_size](#screen_size) +- [set_window_title](#set_window_title) +- [start](#start) +- [toggle_fullscreen](#toggle_fullscreen) +- [window_size](#window_size) +- [window_size_real_pixels](#window_size_real_pixels) +- [Color](#Color) +- [FNCb](#FNCb) +- [FNChar](#FNChar) +- [FNClick](#FNClick) +- [FNEvent](#FNEvent) +- [FNEvent2](#FNEvent2) +- [FNFail](#FNFail) +- [FNKeyDown](#FNKeyDown) +- [FNKeyUp](#FNKeyUp) +- [FNMove](#FNMove) +- [FNUnClick](#FNUnClick) +- [FT](#FT) + - [flush](#flush) +- [TouchPoint](#TouchPoint) +- [EndEnum](#EndEnum) +- [ImageEffect](#ImageEffect) +- [KeyCode](#KeyCode) +- [Modifier](#Modifier) +- [MouseButton](#MouseButton) +- [MouseButtons](#MouseButtons) +- [PaintStyle](#PaintStyle) +- [PenLineType](#PenLineType) +- [Config](#Config) +- [Context](#Context) + - [begin](#begin) + - [cache_image](#cache_image) + - [create_image](#create_image) + - [create_image_from_byte_array](#create_image_from_byte_array) + - [create_image_from_memory](#create_image_from_memory) + - [create_image_with_size](#create_image_with_size) + - [draw_arc_empty](#draw_arc_empty) + - [draw_arc_filled](#draw_arc_filled) + - [draw_arc_line](#draw_arc_line) + - [draw_circle_empty](#draw_circle_empty) + - [draw_circle_filled](#draw_circle_filled) + - [draw_circle_line](#draw_circle_line) + - [draw_circle_with_segments](#draw_circle_with_segments) + - [draw_convex_poly](#draw_convex_poly) + - [draw_cubic_bezier](#draw_cubic_bezier) + - [draw_cubic_bezier_in_steps](#draw_cubic_bezier_in_steps) + - [draw_cubic_bezier_recursive](#draw_cubic_bezier_recursive) + - [draw_cubic_bezier_recursive_scalar](#draw_cubic_bezier_recursive_scalar) + - [draw_ellipse_empty](#draw_ellipse_empty) + - [draw_ellipse_filled](#draw_ellipse_filled) + - [draw_image](#draw_image) + - [draw_image_3d](#draw_image_3d) + - [draw_image_by_id](#draw_image_by_id) + - [draw_image_flipped](#draw_image_flipped) + - [draw_image_part](#draw_image_part) + - [draw_image_with_config](#draw_image_with_config) + - [draw_line](#draw_line) + - [draw_line_with_config](#draw_line_with_config) + - [draw_pixel](#draw_pixel) + - [draw_pixels](#draw_pixels) + - [draw_poly_empty](#draw_poly_empty) + - [draw_polygon_filled](#draw_polygon_filled) + - [draw_rect](#draw_rect) + - [draw_rect_empty](#draw_rect_empty) + - [draw_rect_filled](#draw_rect_filled) + - [draw_rounded_rect_empty](#draw_rounded_rect_empty) + - [draw_rounded_rect_filled](#draw_rounded_rect_filled) + - [draw_slice_empty](#draw_slice_empty) + - [draw_slice_filled](#draw_slice_filled) + - [draw_square_empty](#draw_square_empty) + - [draw_square_filled](#draw_square_filled) + - [draw_text](#draw_text) + - [draw_text2](#draw_text2) + - [draw_text_def](#draw_text_def) + - [draw_text_default](#draw_text_default) + - [draw_triangle_empty](#draw_triangle_empty) + - [draw_triangle_filled](#draw_triangle_filled) + - [end](#end) + - [get_cached_image_by_idx](#get_cached_image_by_idx) + - [has_text_style](#has_text_style) + - [new_streaming_image](#new_streaming_image) + - [quit](#quit) + - [record_frame](#record_frame) + - [refresh_ui](#refresh_ui) + - [remove_cached_image_by_idx](#remove_cached_image_by_idx) + - [resize](#resize) + - [run](#run) + - [scissor_rect](#scissor_rect) + - [set_bg_color](#set_bg_color) + - [set_text_cfg](#set_text_cfg) + - [set_text_style](#set_text_style) + - [show_fps](#show_fps) + - [text_height](#text_height) + - [text_size](#text_size) + - [text_width](#text_width) + - [update_pixel_data](#update_pixel_data) + - [window_size](#window_size) +- [DrawImageConfig](#DrawImageConfig) +- [DrawPixelConfig](#DrawPixelConfig) +- [DrawRectParams](#DrawRectParams) +- [DrawTextParams](#DrawTextParams) +- [EndOptions](#EndOptions) +- [Event](#Event) +- [FPSConfig](#FPSConfig) +- [Image](#Image) + - [init_sokol_image](#init_sokol_image) + - [update_pixel_data](#update_pixel_data) +- [PenConfig](#PenConfig) +- [PipelineContainer](#PipelineContainer) +- [Rect](#Rect) +- [SSRecorderSettings](#SSRecorderSettings) +- [Size](#Size) +- [StreamingImageConfig](#StreamingImageConfig) + +## create_default_pass +[[Return to contents]](#Contents) + +## dpi_scale +[[Return to contents]](#Contents) + +## high_dpi +[[Return to contents]](#Contents) + +## is_fullscreen +[[Return to contents]](#Contents) + +## new_context +[[Return to contents]](#Contents) + +## screen_size +[[Return to contents]](#Contents) + +## set_window_title +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +## toggle_fullscreen +[[Return to contents]](#Contents) + +## window_size +[[Return to contents]](#Contents) + +## window_size_real_pixels +[[Return to contents]](#Contents) + +## Color +[[Return to contents]](#Contents) + +## FNCb +[[Return to contents]](#Contents) + +## FNChar +[[Return to contents]](#Contents) + +## FNClick +[[Return to contents]](#Contents) + +## FNEvent +[[Return to contents]](#Contents) + +## FNEvent2 +[[Return to contents]](#Contents) + +## FNFail +[[Return to contents]](#Contents) + +## FNKeyDown +[[Return to contents]](#Contents) + +## FNKeyUp +[[Return to contents]](#Contents) + +## FNMove +[[Return to contents]](#Contents) + +## FNUnClick +[[Return to contents]](#Contents) + +## FT +## flush +[[Return to contents]](#Contents) + +## TouchPoint +[[Return to contents]](#Contents) + +## EndEnum +[[Return to contents]](#Contents) + +## ImageEffect +[[Return to contents]](#Contents) + +## KeyCode +[[Return to contents]](#Contents) + +## Modifier +[[Return to contents]](#Contents) + +## MouseButton +[[Return to contents]](#Contents) + +## MouseButtons +[[Return to contents]](#Contents) + +## PaintStyle +[[Return to contents]](#Contents) + +## PenLineType +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## begin +[[Return to contents]](#Contents) + +## cache_image +[[Return to contents]](#Contents) + +## create_image +[[Return to contents]](#Contents) + +## create_image_from_byte_array +[[Return to contents]](#Contents) + +## create_image_from_memory +[[Return to contents]](#Contents) + +## create_image_with_size +[[Return to contents]](#Contents) + +## draw_arc_empty +[[Return to contents]](#Contents) + +## draw_arc_filled +[[Return to contents]](#Contents) + +## draw_arc_line +[[Return to contents]](#Contents) + +## draw_circle_empty +[[Return to contents]](#Contents) + +## draw_circle_filled +[[Return to contents]](#Contents) + +## draw_circle_line +[[Return to contents]](#Contents) + +## draw_circle_with_segments +[[Return to contents]](#Contents) + +## draw_convex_poly +[[Return to contents]](#Contents) + +## draw_cubic_bezier +[[Return to contents]](#Contents) + +## draw_cubic_bezier_in_steps +[[Return to contents]](#Contents) + +## draw_cubic_bezier_recursive +[[Return to contents]](#Contents) + +## draw_cubic_bezier_recursive_scalar +[[Return to contents]](#Contents) + +## draw_ellipse_empty +[[Return to contents]](#Contents) + +## draw_ellipse_filled +[[Return to contents]](#Contents) + +## draw_image +[[Return to contents]](#Contents) + +## draw_image_3d +[[Return to contents]](#Contents) + +## draw_image_by_id +[[Return to contents]](#Contents) + +## draw_image_flipped +[[Return to contents]](#Contents) + +## draw_image_part +[[Return to contents]](#Contents) + +## draw_image_with_config +[[Return to contents]](#Contents) + +## draw_line +[[Return to contents]](#Contents) + +## draw_line_with_config +[[Return to contents]](#Contents) + +## draw_pixel +[[Return to contents]](#Contents) + +## draw_pixels +[[Return to contents]](#Contents) + +## draw_poly_empty +[[Return to contents]](#Contents) + +## draw_polygon_filled +[[Return to contents]](#Contents) + +## draw_rect +[[Return to contents]](#Contents) + +## draw_rect_empty +[[Return to contents]](#Contents) + +## draw_rect_filled +[[Return to contents]](#Contents) + +## draw_rounded_rect_empty +[[Return to contents]](#Contents) + +## draw_rounded_rect_filled +[[Return to contents]](#Contents) + +## draw_slice_empty +[[Return to contents]](#Contents) + +## draw_slice_filled +[[Return to contents]](#Contents) + +## draw_square_empty +[[Return to contents]](#Contents) + +## draw_square_filled +[[Return to contents]](#Contents) + +## draw_text +[[Return to contents]](#Contents) + +## draw_text2 +[[Return to contents]](#Contents) + +## draw_text_def +[[Return to contents]](#Contents) + +## draw_text_default +[[Return to contents]](#Contents) + +## draw_triangle_empty +[[Return to contents]](#Contents) + +## draw_triangle_filled +[[Return to contents]](#Contents) + +## end +[[Return to contents]](#Contents) + +## get_cached_image_by_idx +[[Return to contents]](#Contents) + +## has_text_style +[[Return to contents]](#Contents) + +## new_streaming_image +[[Return to contents]](#Contents) + +## quit +[[Return to contents]](#Contents) + +## record_frame +[[Return to contents]](#Contents) + +## refresh_ui +[[Return to contents]](#Contents) + +## remove_cached_image_by_idx +[[Return to contents]](#Contents) + +## resize +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## scissor_rect +[[Return to contents]](#Contents) + +## set_bg_color +[[Return to contents]](#Contents) + +## set_text_cfg +[[Return to contents]](#Contents) + +## set_text_style +[[Return to contents]](#Contents) + +## show_fps +[[Return to contents]](#Contents) + +## text_height +[[Return to contents]](#Contents) + +## text_size +[[Return to contents]](#Contents) + +## text_width +[[Return to contents]](#Contents) + +## update_pixel_data +[[Return to contents]](#Contents) + +## window_size +[[Return to contents]](#Contents) + +## DrawImageConfig +[[Return to contents]](#Contents) + +## DrawPixelConfig +[[Return to contents]](#Contents) + +## DrawRectParams +[[Return to contents]](#Contents) + +## DrawTextParams +[[Return to contents]](#Contents) + +## EndOptions +[[Return to contents]](#Contents) + +## Event +[[Return to contents]](#Contents) + +## FPSConfig +[[Return to contents]](#Contents) + +## Image +[[Return to contents]](#Contents) + +## init_sokol_image +[[Return to contents]](#Contents) + +## update_pixel_data +[[Return to contents]](#Contents) + +## PenConfig +[[Return to contents]](#Contents) + +## PipelineContainer +[[Return to contents]](#Contents) + +## Rect +[[Return to contents]](#Contents) + +## SSRecorderSettings +[[Return to contents]](#Contents) + +## Size +[[Return to contents]](#Contents) + +## StreamingImageConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/gx.md b/vdocs/gx.md new file mode 100644 index 00000000..29b13604 --- /dev/null +++ b/vdocs/gx.md @@ -0,0 +1,144 @@ +# module gx + + +## Contents +- [Constants](#Constants) +- [color_from_string](#color_from_string) +- [hex](#hex) +- [rgb](#rgb) +- [rgba](#rgba) +- [HorizontalAlign](#HorizontalAlign) +- [VerticalAlign](#VerticalAlign) +- [Color](#Color) + - [+](#+) + - [-](#-) + - [*](#*) + - [/](#/) + - [over](#over) + - [eq](#eq) + - [str](#str) + - [rgba8](#rgba8) + - [bgra8](#bgra8) + - [abgr8](#abgr8) + - [to_css_string](#to_css_string) +- [Image](#Image) + - [is_empty](#is_empty) +- [TextCfg](#TextCfg) + - [to_css_string](#to_css_string) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## color_from_string +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## rgb +[[Return to contents]](#Contents) + +## rgba +[[Return to contents]](#Contents) + +## HorizontalAlign +[[Return to contents]](#Contents) + +## VerticalAlign +[[Return to contents]](#Contents) + +## Color +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## over +[[Return to contents]](#Contents) + +## eq +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## rgba8 +[[Return to contents]](#Contents) + +## bgra8 +[[Return to contents]](#Contents) + +## abgr8 +[[Return to contents]](#Contents) + +## to_css_string +[[Return to contents]](#Contents) + +## Image +[[Return to contents]](#Contents) + +## is_empty +[[Return to contents]](#Contents) + +## TextCfg +[[Return to contents]](#Contents) + +## to_css_string +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/hash.crc32.md b/vdocs/hash.crc32.md new file mode 100644 index 00000000..2e7ef589 --- /dev/null +++ b/vdocs/hash.crc32.md @@ -0,0 +1,28 @@ +# module hash.crc32 + + +## Contents +- [Constants](#Constants) +- [new](#new) +- [sum](#sum) +- [Crc32](#Crc32) + - [checksum](#checksum) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## Crc32 +## checksum +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/hash.fnv1a.md b/vdocs/hash.fnv1a.md new file mode 100644 index 00000000..b7c3daba --- /dev/null +++ b/vdocs/hash.fnv1a.md @@ -0,0 +1,38 @@ +# module hash.fnv1a + + +## Contents +- [sum32](#sum32) +- [sum32_bytes](#sum32_bytes) +- [sum32_string](#sum32_string) +- [sum32_struct](#sum32_struct) +- [sum64](#sum64) +- [sum64_bytes](#sum64_bytes) +- [sum64_string](#sum64_string) +- [sum64_struct](#sum64_struct) + +## sum32 +[[Return to contents]](#Contents) + +## sum32_bytes +[[Return to contents]](#Contents) + +## sum32_string +[[Return to contents]](#Contents) + +## sum32_struct +[[Return to contents]](#Contents) + +## sum64 +[[Return to contents]](#Contents) + +## sum64_bytes +[[Return to contents]](#Contents) + +## sum64_string +[[Return to contents]](#Contents) + +## sum64_struct +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/hash.md b/vdocs/hash.md new file mode 100644 index 00000000..4f1c2678 --- /dev/null +++ b/vdocs/hash.md @@ -0,0 +1,30 @@ +# module hash + + +## Contents +- [sum64](#sum64) +- [sum64_string](#sum64_string) +- [wyhash64_c](#wyhash64_c) +- [wyhash_c](#wyhash_c) +- [wymum](#wymum) +- [Hash](#Hash) + +## sum64 +[[Return to contents]](#Contents) + +## sum64_string +[[Return to contents]](#Contents) + +## wyhash64_c +[[Return to contents]](#Contents) + +## wyhash_c +[[Return to contents]](#Contents) + +## wymum +[[Return to contents]](#Contents) + +## Hash +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/io.md b/vdocs/io.md new file mode 100644 index 00000000..b06000f9 --- /dev/null +++ b/vdocs/io.md @@ -0,0 +1,150 @@ +# module io + + +## Contents +- [Constants](#Constants) +- [cp](#cp) +- [make_readerwriter](#make_readerwriter) +- [new_buffered_reader](#new_buffered_reader) +- [new_buffered_writer](#new_buffered_writer) +- [new_multi_writer](#new_multi_writer) +- [read_all](#read_all) +- [read_any](#read_any) +- [RandomReader](#RandomReader) +- [RandomWriter](#RandomWriter) +- [Reader](#Reader) +- [ReaderWriter](#ReaderWriter) +- [Writer](#Writer) +- [ReaderWriterImpl](#ReaderWriterImpl) + - [read](#read) + - [write](#write) +- [BufferedReadLineConfig](#BufferedReadLineConfig) +- [BufferedReader](#BufferedReader) + - [read](#read) + - [free](#free) + - [end_of_stream](#end_of_stream) + - [read_line](#read_line) +- [BufferedReaderConfig](#BufferedReaderConfig) +- [BufferedWriter](#BufferedWriter) + - [reset](#reset) + - [buffered](#buffered) + - [flush](#flush) + - [available](#available) + - [write](#write) +- [BufferedWriterConfig](#BufferedWriterConfig) +- [CopySettings](#CopySettings) +- [Eof](#Eof) +- [MultiWriter](#MultiWriter) + - [write](#write) +- [NotExpected](#NotExpected) +- [ReadAllConfig](#ReadAllConfig) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## cp +[[Return to contents]](#Contents) + +## make_readerwriter +[[Return to contents]](#Contents) + +## new_buffered_reader +[[Return to contents]](#Contents) + +## new_buffered_writer +[[Return to contents]](#Contents) + +## new_multi_writer +[[Return to contents]](#Contents) + +## read_all +[[Return to contents]](#Contents) + +## read_any +[[Return to contents]](#Contents) + +## RandomReader +[[Return to contents]](#Contents) + +## RandomWriter +[[Return to contents]](#Contents) + +## Reader +[[Return to contents]](#Contents) + +## ReaderWriter +[[Return to contents]](#Contents) + +## Writer +[[Return to contents]](#Contents) + +## ReaderWriterImpl +## read +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## BufferedReadLineConfig +[[Return to contents]](#Contents) + +## BufferedReader +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## end_of_stream +[[Return to contents]](#Contents) + +## read_line +[[Return to contents]](#Contents) + +## BufferedReaderConfig +[[Return to contents]](#Contents) + +## BufferedWriter +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## buffered +[[Return to contents]](#Contents) + +## flush +[[Return to contents]](#Contents) + +## available +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## BufferedWriterConfig +[[Return to contents]](#Contents) + +## CopySettings +[[Return to contents]](#Contents) + +## Eof +[[Return to contents]](#Contents) + +## MultiWriter +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## NotExpected +[[Return to contents]](#Contents) + +## ReadAllConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/io.string_reader.md b/vdocs/io.string_reader.md new file mode 100644 index 00000000..d393111c --- /dev/null +++ b/vdocs/io.string_reader.md @@ -0,0 +1,86 @@ +# module io.string_reader + + +## Contents +- [StringReader.new](#StringReader.new) +- [StringReader](#StringReader) + - [needs_fill](#needs_fill) + - [needs_fill_until](#needs_fill_until) + - [fill_buffer](#fill_buffer) + - [fill_buffer_until](#fill_buffer_until) + - [read_all_bytes](#read_all_bytes) + - [read_all](#read_all) + - [read_bytes](#read_bytes) + - [read_string](#read_string) + - [read](#read) + - [read_line](#read_line) + - [write](#write) + - [get_data](#get_data) + - [get_part](#get_part) + - [get_string](#get_string) + - [get_string_part](#get_string_part) + - [flush](#flush) + - [free](#free) +- [StringReaderParams](#StringReaderParams) + +## StringReader.new +[[Return to contents]](#Contents) + +## StringReader +[[Return to contents]](#Contents) + +## needs_fill +[[Return to contents]](#Contents) + +## needs_fill_until +[[Return to contents]](#Contents) + +## fill_buffer +[[Return to contents]](#Contents) + +## fill_buffer_until +[[Return to contents]](#Contents) + +## read_all_bytes +[[Return to contents]](#Contents) + +## read_all +[[Return to contents]](#Contents) + +## read_bytes +[[Return to contents]](#Contents) + +## read_string +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## read_line +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## get_data +[[Return to contents]](#Contents) + +## get_part +[[Return to contents]](#Contents) + +## get_string +[[Return to contents]](#Contents) + +## get_string_part +[[Return to contents]](#Contents) + +## flush +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## StringReaderParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/io.util.md b/vdocs/io.util.md new file mode 100644 index 00000000..33832657 --- /dev/null +++ b/vdocs/io.util.md @@ -0,0 +1,22 @@ +# module io.util + + +## Contents +- [temp_dir](#temp_dir) +- [temp_file](#temp_file) +- [TempDirOptions](#TempDirOptions) +- [TempFileOptions](#TempFileOptions) + +## temp_dir +[[Return to contents]](#Contents) + +## temp_file +[[Return to contents]](#Contents) + +## TempDirOptions +[[Return to contents]](#Contents) + +## TempFileOptions +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/json.cjson.md b/vdocs/json.cjson.md new file mode 100644 index 00000000..3f3291aa --- /dev/null +++ b/vdocs/json.cjson.md @@ -0,0 +1,82 @@ +# module json.cjson + + +## Contents +- [create_array](#create_array) +- [create_bool](#create_bool) +- [create_false](#create_false) +- [create_null](#create_null) +- [create_number](#create_number) +- [create_object](#create_object) +- [create_raw](#create_raw) +- [create_string](#create_string) +- [create_true](#create_true) +- [delete](#delete) +- [version](#version) +- [Node](#Node) + - [add_item_to_object](#add_item_to_object) + - [add_item_to_array](#add_item_to_array) + - [print](#print) + - [print_unformatted](#print_unformatted) + - [str](#str) +- [CJsonType](#CJsonType) +- [C.cJSON](#C.cJSON) + +## create_array +[[Return to contents]](#Contents) + +## create_bool +[[Return to contents]](#Contents) + +## create_false +[[Return to contents]](#Contents) + +## create_null +[[Return to contents]](#Contents) + +## create_number +[[Return to contents]](#Contents) + +## create_object +[[Return to contents]](#Contents) + +## create_raw +[[Return to contents]](#Contents) + +## create_string +[[Return to contents]](#Contents) + +## create_true +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## version +[[Return to contents]](#Contents) + +## Node +[[Return to contents]](#Contents) + +## add_item_to_object +[[Return to contents]](#Contents) + +## add_item_to_array +[[Return to contents]](#Contents) + +## print +[[Return to contents]](#Contents) + +## print_unformatted +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## CJsonType +[[Return to contents]](#Contents) + +## C.cJSON +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/json.md b/vdocs/json.md new file mode 100644 index 00000000..485aad50 --- /dev/null +++ b/vdocs/json.md @@ -0,0 +1,22 @@ +# module json + + +## Contents +- [decode](#decode) +- [encode](#encode) +- [encode_pretty](#encode_pretty) +- [C.cJSON](#C.cJSON) + +## decode +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## encode_pretty +[[Return to contents]](#Contents) + +## C.cJSON +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/log.md b/vdocs/log.md new file mode 100644 index 00000000..e8f7cecb --- /dev/null +++ b/vdocs/log.md @@ -0,0 +1,218 @@ +# module log + + +## Contents +- [debug](#debug) +- [error](#error) +- [fatal](#fatal) +- [get_level](#get_level) +- [get_logger](#get_logger) +- [info](#info) +- [level_from_tag](#level_from_tag) +- [new_thread_safe_log](#new_thread_safe_log) +- [set_always_flush](#set_always_flush) +- [set_level](#set_level) +- [set_logger](#set_logger) +- [target_from_label](#target_from_label) +- [use_stdout](#use_stdout) +- [warn](#warn) +- [Logger](#Logger) +- [Level](#Level) +- [LogTarget](#LogTarget) +- [TimeFormat](#TimeFormat) +- [C.log__Logger](#C.log__Logger) +- [Log](#Log) + - [get_level](#get_level) + - [set_level](#set_level) + - [set_full_logpath](#set_full_logpath) + - [set_output_label](#set_output_label) + - [set_output_path](#set_output_path) + - [set_output_stream](#set_output_stream) + - [log_to_console_too](#log_to_console_too) + - [flush](#flush) + - [close](#close) + - [reopen](#reopen) + - [send_output](#send_output) + - [fatal](#fatal) + - [error](#error) + - [warn](#warn) + - [info](#info) + - [debug](#debug) + - [free](#free) + - [set_time_format](#set_time_format) + - [set_always_flush](#set_always_flush) + - [get_time_format](#get_time_format) + - [set_custom_time_format](#set_custom_time_format) + - [get_custom_time_format](#get_custom_time_format) + - [set_short_tag](#set_short_tag) + - [get_short_tag](#get_short_tag) +- [ThreadSafeLog](#ThreadSafeLog) + - [free](#free) + - [set_level](#set_level) + - [set_always_flush](#set_always_flush) + - [debug](#debug) + - [info](#info) + - [warn](#warn) + - [error](#error) + - [fatal](#fatal) + +## debug +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## fatal +[[Return to contents]](#Contents) + +## get_level +[[Return to contents]](#Contents) + +## get_logger +[[Return to contents]](#Contents) + +## info +[[Return to contents]](#Contents) + +## level_from_tag +[[Return to contents]](#Contents) + +## new_thread_safe_log +[[Return to contents]](#Contents) + +## set_always_flush +[[Return to contents]](#Contents) + +## set_level +[[Return to contents]](#Contents) + +## set_logger +[[Return to contents]](#Contents) + +## target_from_label +[[Return to contents]](#Contents) + +## use_stdout +[[Return to contents]](#Contents) + +## warn +[[Return to contents]](#Contents) + +## Logger +[[Return to contents]](#Contents) + +## Level +[[Return to contents]](#Contents) + +## LogTarget +[[Return to contents]](#Contents) + +## TimeFormat +[[Return to contents]](#Contents) + +## C.log__Logger +[[Return to contents]](#Contents) + +## Log +[[Return to contents]](#Contents) + +## get_level +[[Return to contents]](#Contents) + +## set_level +[[Return to contents]](#Contents) + +## set_full_logpath +[[Return to contents]](#Contents) + +## set_output_label +[[Return to contents]](#Contents) + +## set_output_path +[[Return to contents]](#Contents) + +## set_output_stream +[[Return to contents]](#Contents) + +## log_to_console_too +[[Return to contents]](#Contents) + +## flush +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## reopen +[[Return to contents]](#Contents) + +## send_output +[[Return to contents]](#Contents) + +## fatal +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## warn +[[Return to contents]](#Contents) + +## info +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## set_time_format +[[Return to contents]](#Contents) + +## set_always_flush +[[Return to contents]](#Contents) + +## get_time_format +[[Return to contents]](#Contents) + +## set_custom_time_format +[[Return to contents]](#Contents) + +## get_custom_time_format +[[Return to contents]](#Contents) + +## set_short_tag +[[Return to contents]](#Contents) + +## get_short_tag +[[Return to contents]](#Contents) + +## ThreadSafeLog +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## set_level +[[Return to contents]](#Contents) + +## set_always_flush +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## info +[[Return to contents]](#Contents) + +## warn +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## fatal +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/main.md b/vdocs/main.md new file mode 100644 index 00000000..69c46eac --- /dev/null +++ b/vdocs/main.md @@ -0,0 +1,22 @@ +# module main + + +## Contents +- [extract_transitions](#extract_transitions) +- [get_transitions](#get_transitions) +- [main](#main) +- [read_file](#read_file) + +## extract_transitions +[[Return to contents]](#Contents) + +## get_transitions +[[Return to contents]](#Contents) + +## main +[[Return to contents]](#Contents) + +## read_file +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/maps.md b/vdocs/maps.md new file mode 100644 index 00000000..c2c9edb3 --- /dev/null +++ b/vdocs/maps.md @@ -0,0 +1,38 @@ +# module maps + + +## Contents +- [filter](#filter) +- [flat_map](#flat_map) +- [from_array](#from_array) +- [invert](#invert) +- [merge](#merge) +- [merge_in_place](#merge_in_place) +- [to_array](#to_array) +- [to_map](#to_map) + +## filter +[[Return to contents]](#Contents) + +## flat_map +[[Return to contents]](#Contents) + +## from_array +[[Return to contents]](#Contents) + +## invert +[[Return to contents]](#Contents) + +## merge +[[Return to contents]](#Contents) + +## merge_in_place +[[Return to contents]](#Contents) + +## to_array +[[Return to contents]](#Contents) + +## to_map +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.big.md b/vdocs/math.big.md new file mode 100644 index 00000000..b2060459 --- /dev/null +++ b/vdocs/math.big.md @@ -0,0 +1,224 @@ +# module math.big + + +## Contents +- [Constants](#Constants) +- [integer_from_bytes](#integer_from_bytes) +- [integer_from_i64](#integer_from_i64) +- [integer_from_int](#integer_from_int) +- [integer_from_radix](#integer_from_radix) +- [integer_from_string](#integer_from_string) +- [integer_from_u32](#integer_from_u32) +- [integer_from_u64](#integer_from_u64) +- [Integer](#Integer) + - [abs](#abs) + - [neg](#neg) + - [+](#+) + - [-](#-) + - [*](#*) + - [div_mod](#div_mod) + - [div_mod_checked](#div_mod_checked) + - [/](#/) + - [%](#%) + - [div_checked](#div_checked) + - [mod_checked](#mod_checked) + - [pow](#pow) + - [mod_pow](#mod_pow) + - [big_mod_pow](#big_mod_pow) + - [inc](#inc) + - [dec](#dec) + - [==](#==) + - [abs_cmp](#abs_cmp) + - [<](#<) + - [get_bit](#get_bit) + - [set_bit](#set_bit) + - [bitwise_or](#bitwise_or) + - [bitwise_and](#bitwise_and) + - [bitwise_not](#bitwise_not) + - [bitwise_xor](#bitwise_xor) + - [left_shift](#left_shift) + - [right_shift](#right_shift) + - [bin_str](#bin_str) + - [hex](#hex) + - [radix_str](#radix_str) + - [str](#str) + - [int](#int) + - [bytes](#bytes) + - [factorial](#factorial) + - [isqrt](#isqrt) + - [isqrt_checked](#isqrt_checked) + - [gcd](#gcd) + - [gcd_binary](#gcd_binary) + - [gcd_euclid](#gcd_euclid) + - [mod_inverse](#mod_inverse) + - [is_odd](#is_odd) + - [is_power_of_2](#is_power_of_2) + - [bit_len](#bit_len) +- [IntegerConfig](#IntegerConfig) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## integer_from_bytes +[[Return to contents]](#Contents) + +## integer_from_i64 +[[Return to contents]](#Contents) + +## integer_from_int +[[Return to contents]](#Contents) + +## integer_from_radix +[[Return to contents]](#Contents) + +## integer_from_string +[[Return to contents]](#Contents) + +## integer_from_u32 +[[Return to contents]](#Contents) + +## integer_from_u64 +[[Return to contents]](#Contents) + +## Integer +[[Return to contents]](#Contents) + +## abs +[[Return to contents]](#Contents) + +## neg +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## div_mod +[[Return to contents]](#Contents) + +## div_mod_checked +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## % +[[Return to contents]](#Contents) + +## div_checked +[[Return to contents]](#Contents) + +## mod_checked +[[Return to contents]](#Contents) + +## pow +[[Return to contents]](#Contents) + +## mod_pow +[[Return to contents]](#Contents) + +## big_mod_pow +[[Return to contents]](#Contents) + +## inc +[[Return to contents]](#Contents) + +## dec +[[Return to contents]](#Contents) + +## == +[[Return to contents]](#Contents) + +## abs_cmp +[[Return to contents]](#Contents) + +## < +[[Return to contents]](#Contents) + +## get_bit +[[Return to contents]](#Contents) + +## set_bit +[[Return to contents]](#Contents) + +## bitwise_or +[[Return to contents]](#Contents) + +## bitwise_and +[[Return to contents]](#Contents) + +## bitwise_not +[[Return to contents]](#Contents) + +## bitwise_xor +[[Return to contents]](#Contents) + +## left_shift +[[Return to contents]](#Contents) + +## right_shift +[[Return to contents]](#Contents) + +## bin_str +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## radix_str +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## factorial +[[Return to contents]](#Contents) + +## isqrt +[[Return to contents]](#Contents) + +## isqrt_checked +[[Return to contents]](#Contents) + +## gcd +[[Return to contents]](#Contents) + +## gcd_binary +[[Return to contents]](#Contents) + +## gcd_euclid +[[Return to contents]](#Contents) + +## mod_inverse +[[Return to contents]](#Contents) + +## is_odd +[[Return to contents]](#Contents) + +## is_power_of_2 +[[Return to contents]](#Contents) + +## bit_len +[[Return to contents]](#Contents) + +## IntegerConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.bits.md b/vdocs/math.bits.md new file mode 100644 index 00000000..afa7ed7a --- /dev/null +++ b/vdocs/math.bits.md @@ -0,0 +1,174 @@ +# module math.bits + + +## Contents +- [add_32](#add_32) +- [add_64](#add_64) +- [div_32](#div_32) +- [div_64](#div_64) +- [f32_bits](#f32_bits) +- [f32_from_bits](#f32_from_bits) +- [f64_bits](#f64_bits) +- [f64_from_bits](#f64_from_bits) +- [leading_zeros_16](#leading_zeros_16) +- [leading_zeros_32](#leading_zeros_32) +- [leading_zeros_64](#leading_zeros_64) +- [leading_zeros_8](#leading_zeros_8) +- [len_16](#len_16) +- [len_32](#len_32) +- [len_64](#len_64) +- [len_8](#len_8) +- [mul_32](#mul_32) +- [mul_64](#mul_64) +- [normalize](#normalize) +- [ones_count_16](#ones_count_16) +- [ones_count_32](#ones_count_32) +- [ones_count_64](#ones_count_64) +- [ones_count_8](#ones_count_8) +- [rem_32](#rem_32) +- [rem_64](#rem_64) +- [reverse_16](#reverse_16) +- [reverse_32](#reverse_32) +- [reverse_64](#reverse_64) +- [reverse_8](#reverse_8) +- [reverse_bytes_16](#reverse_bytes_16) +- [reverse_bytes_32](#reverse_bytes_32) +- [reverse_bytes_64](#reverse_bytes_64) +- [rotate_left_16](#rotate_left_16) +- [rotate_left_32](#rotate_left_32) +- [rotate_left_64](#rotate_left_64) +- [rotate_left_8](#rotate_left_8) +- [sub_32](#sub_32) +- [sub_64](#sub_64) +- [trailing_zeros_16](#trailing_zeros_16) +- [trailing_zeros_32](#trailing_zeros_32) +- [trailing_zeros_64](#trailing_zeros_64) +- [trailing_zeros_8](#trailing_zeros_8) + +## add_32 +[[Return to contents]](#Contents) + +## add_64 +[[Return to contents]](#Contents) + +## div_32 +[[Return to contents]](#Contents) + +## div_64 +[[Return to contents]](#Contents) + +## f32_bits +[[Return to contents]](#Contents) + +## f32_from_bits +[[Return to contents]](#Contents) + +## f64_bits +[[Return to contents]](#Contents) + +## f64_from_bits +[[Return to contents]](#Contents) + +## leading_zeros_16 +[[Return to contents]](#Contents) + +## leading_zeros_32 +[[Return to contents]](#Contents) + +## leading_zeros_64 +[[Return to contents]](#Contents) + +## leading_zeros_8 +[[Return to contents]](#Contents) + +## len_16 +[[Return to contents]](#Contents) + +## len_32 +[[Return to contents]](#Contents) + +## len_64 +[[Return to contents]](#Contents) + +## len_8 +[[Return to contents]](#Contents) + +## mul_32 +[[Return to contents]](#Contents) + +## mul_64 +[[Return to contents]](#Contents) + +## normalize +[[Return to contents]](#Contents) + +## ones_count_16 +[[Return to contents]](#Contents) + +## ones_count_32 +[[Return to contents]](#Contents) + +## ones_count_64 +[[Return to contents]](#Contents) + +## ones_count_8 +[[Return to contents]](#Contents) + +## rem_32 +[[Return to contents]](#Contents) + +## rem_64 +[[Return to contents]](#Contents) + +## reverse_16 +[[Return to contents]](#Contents) + +## reverse_32 +[[Return to contents]](#Contents) + +## reverse_64 +[[Return to contents]](#Contents) + +## reverse_8 +[[Return to contents]](#Contents) + +## reverse_bytes_16 +[[Return to contents]](#Contents) + +## reverse_bytes_32 +[[Return to contents]](#Contents) + +## reverse_bytes_64 +[[Return to contents]](#Contents) + +## rotate_left_16 +[[Return to contents]](#Contents) + +## rotate_left_32 +[[Return to contents]](#Contents) + +## rotate_left_64 +[[Return to contents]](#Contents) + +## rotate_left_8 +[[Return to contents]](#Contents) + +## sub_32 +[[Return to contents]](#Contents) + +## sub_64 +[[Return to contents]](#Contents) + +## trailing_zeros_16 +[[Return to contents]](#Contents) + +## trailing_zeros_32 +[[Return to contents]](#Contents) + +## trailing_zeros_64 +[[Return to contents]](#Contents) + +## trailing_zeros_8 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.complex.md b/vdocs/math.complex.md new file mode 100644 index 00000000..0a796a5a --- /dev/null +++ b/vdocs/math.complex.md @@ -0,0 +1,198 @@ +# module math.complex + + +## Contents +- [complex](#complex) +- [Complex](#Complex) + - [str](#str) + - [abs](#abs) + - [mod](#mod) + - [angle](#angle) + - [+](#+) + - [-](#-) + - [*](#*) + - [/](#/) + - [add](#add) + - [subtract](#subtract) + - [multiply](#multiply) + - [divide](#divide) + - [conjugate](#conjugate) + - [addinv](#addinv) + - [mulinv](#mulinv) + - [pow](#pow) + - [root](#root) + - [exp](#exp) + - [ln](#ln) + - [log](#log) + - [arg](#arg) + - [cpow](#cpow) + - [sin](#sin) + - [cos](#cos) + - [tan](#tan) + - [cot](#cot) + - [sec](#sec) + - [csc](#csc) + - [asin](#asin) + - [acos](#acos) + - [atan](#atan) + - [acot](#acot) + - [asec](#asec) + - [acsc](#acsc) + - [sinh](#sinh) + - [cosh](#cosh) + - [tanh](#tanh) + - [coth](#coth) + - [sech](#sech) + - [csch](#csch) + - [asinh](#asinh) + - [acosh](#acosh) + - [atanh](#atanh) + - [acoth](#acoth) + - [acsch](#acsch) + - [equals](#equals) + +## complex +[[Return to contents]](#Contents) + +## Complex +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## abs +[[Return to contents]](#Contents) + +## mod +[[Return to contents]](#Contents) + +## angle +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## subtract +[[Return to contents]](#Contents) + +## multiply +[[Return to contents]](#Contents) + +## divide +[[Return to contents]](#Contents) + +## conjugate +[[Return to contents]](#Contents) + +## addinv +[[Return to contents]](#Contents) + +## mulinv +[[Return to contents]](#Contents) + +## pow +[[Return to contents]](#Contents) + +## root +[[Return to contents]](#Contents) + +## exp +[[Return to contents]](#Contents) + +## ln +[[Return to contents]](#Contents) + +## log +[[Return to contents]](#Contents) + +## arg +[[Return to contents]](#Contents) + +## cpow +[[Return to contents]](#Contents) + +## sin +[[Return to contents]](#Contents) + +## cos +[[Return to contents]](#Contents) + +## tan +[[Return to contents]](#Contents) + +## cot +[[Return to contents]](#Contents) + +## sec +[[Return to contents]](#Contents) + +## csc +[[Return to contents]](#Contents) + +## asin +[[Return to contents]](#Contents) + +## acos +[[Return to contents]](#Contents) + +## atan +[[Return to contents]](#Contents) + +## acot +[[Return to contents]](#Contents) + +## asec +[[Return to contents]](#Contents) + +## acsc +[[Return to contents]](#Contents) + +## sinh +[[Return to contents]](#Contents) + +## cosh +[[Return to contents]](#Contents) + +## tanh +[[Return to contents]](#Contents) + +## coth +[[Return to contents]](#Contents) + +## sech +[[Return to contents]](#Contents) + +## csch +[[Return to contents]](#Contents) + +## asinh +[[Return to contents]](#Contents) + +## acosh +[[Return to contents]](#Contents) + +## atanh +[[Return to contents]](#Contents) + +## acoth +[[Return to contents]](#Contents) + +## acsch +[[Return to contents]](#Contents) + +## equals +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.easing.md b/vdocs/math.easing.md new file mode 100644 index 00000000..d87ca890 --- /dev/null +++ b/vdocs/math.easing.md @@ -0,0 +1,134 @@ +# module math.easing + + +## Contents +- [in_back](#in_back) +- [in_bounce](#in_bounce) +- [in_circ](#in_circ) +- [in_cubic](#in_cubic) +- [in_elastic](#in_elastic) +- [in_expo](#in_expo) +- [in_out_back](#in_out_back) +- [in_out_bounce](#in_out_bounce) +- [in_out_circ](#in_out_circ) +- [in_out_cubic](#in_out_cubic) +- [in_out_elastic](#in_out_elastic) +- [in_out_expo](#in_out_expo) +- [in_out_quad](#in_out_quad) +- [in_out_quart](#in_out_quart) +- [in_out_quint](#in_out_quint) +- [in_out_sine](#in_out_sine) +- [in_quad](#in_quad) +- [in_quart](#in_quart) +- [in_quint](#in_quint) +- [in_sine](#in_sine) +- [linear](#linear) +- [out_back](#out_back) +- [out_bounce](#out_bounce) +- [out_circ](#out_circ) +- [out_cubic](#out_cubic) +- [out_elastic](#out_elastic) +- [out_expo](#out_expo) +- [out_quad](#out_quad) +- [out_quart](#out_quart) +- [out_quint](#out_quint) +- [out_sine](#out_sine) +- [EasingFN](#EasingFN) + +## in_back +[[Return to contents]](#Contents) + +## in_bounce +[[Return to contents]](#Contents) + +## in_circ +[[Return to contents]](#Contents) + +## in_cubic +[[Return to contents]](#Contents) + +## in_elastic +[[Return to contents]](#Contents) + +## in_expo +[[Return to contents]](#Contents) + +## in_out_back +[[Return to contents]](#Contents) + +## in_out_bounce +[[Return to contents]](#Contents) + +## in_out_circ +[[Return to contents]](#Contents) + +## in_out_cubic +[[Return to contents]](#Contents) + +## in_out_elastic +[[Return to contents]](#Contents) + +## in_out_expo +[[Return to contents]](#Contents) + +## in_out_quad +[[Return to contents]](#Contents) + +## in_out_quart +[[Return to contents]](#Contents) + +## in_out_quint +[[Return to contents]](#Contents) + +## in_out_sine +[[Return to contents]](#Contents) + +## in_quad +[[Return to contents]](#Contents) + +## in_quart +[[Return to contents]](#Contents) + +## in_quint +[[Return to contents]](#Contents) + +## in_sine +[[Return to contents]](#Contents) + +## linear +[[Return to contents]](#Contents) + +## out_back +[[Return to contents]](#Contents) + +## out_bounce +[[Return to contents]](#Contents) + +## out_circ +[[Return to contents]](#Contents) + +## out_cubic +[[Return to contents]](#Contents) + +## out_elastic +[[Return to contents]](#Contents) + +## out_expo +[[Return to contents]](#Contents) + +## out_quad +[[Return to contents]](#Contents) + +## out_quart +[[Return to contents]](#Contents) + +## out_quint +[[Return to contents]](#Contents) + +## out_sine +[[Return to contents]](#Contents) + +## EasingFN +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.fractions.md b/vdocs/math.fractions.md new file mode 100644 index 00000000..3679a14e --- /dev/null +++ b/vdocs/math.fractions.md @@ -0,0 +1,66 @@ +# module math.fractions + + +## Contents +- [approximate](#approximate) +- [approximate_with_eps](#approximate_with_eps) +- [fraction](#fraction) +- [Fraction](#Fraction) + - [str](#str) + - [+](#+) + - [-](#-) + - [*](#*) + - [/](#/) + - [negate](#negate) + - [reciprocal](#reciprocal) + - [reduce](#reduce) + - [f64](#f64) + - [==](#==) + - [<](#<) + +## approximate +[[Return to contents]](#Contents) + +## approximate_with_eps +[[Return to contents]](#Contents) + +## fraction +[[Return to contents]](#Contents) + +## Fraction +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## negate +[[Return to contents]](#Contents) + +## reciprocal +[[Return to contents]](#Contents) + +## reduce +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## == +[[Return to contents]](#Contents) + +## < +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.internal.md b/vdocs/math.internal.md new file mode 100644 index 00000000..b19fb6ba --- /dev/null +++ b/vdocs/math.internal.md @@ -0,0 +1,112 @@ +# module math.internal + + +## Contents +- [Constants](#Constants) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.md b/vdocs/math.md new file mode 100644 index 00000000..47524a6f --- /dev/null +++ b/vdocs/math.md @@ -0,0 +1,541 @@ +# module math + + +## Contents +- [Constants](#Constants) +- [abs](#abs) +- [acos](#acos) +- [acosh](#acosh) +- [alike](#alike) +- [angle_diff](#angle_diff) +- [aprox_cos](#aprox_cos) +- [aprox_sin](#aprox_sin) +- [asin](#asin) +- [asinh](#asinh) +- [atan](#atan) +- [atan2](#atan2) +- [atanh](#atanh) +- [cbrt](#cbrt) +- [ceil](#ceil) +- [clamp](#clamp) +- [clip](#clip) +- [close](#close) +- [copysign](#copysign) +- [cos](#cos) +- [cosf](#cosf) +- [cosh](#cosh) +- [cot](#cot) +- [count_digits](#count_digits) +- [cube](#cube) +- [cubic_bezier](#cubic_bezier) +- [cubic_bezier_a](#cubic_bezier_a) +- [cubic_bezier_coords](#cubic_bezier_coords) +- [cubic_bezier_fa](#cubic_bezier_fa) +- [degrees](#degrees) +- [digits](#digits) +- [divide_euclid](#divide_euclid) +- [divide_floored](#divide_floored) +- [divide_truncated](#divide_truncated) +- [egcd](#egcd) +- [erf](#erf) +- [erfc](#erfc) +- [exp](#exp) +- [exp2](#exp2) +- [expm1](#expm1) +- [f32_bits](#f32_bits) +- [f32_from_bits](#f32_from_bits) +- [f64_bits](#f64_bits) +- [f64_from_bits](#f64_from_bits) +- [factorial](#factorial) +- [factoriali](#factoriali) +- [floor](#floor) +- [floorf](#floorf) +- [fmod](#fmod) +- [frexp](#frexp) +- [gamma](#gamma) +- [gcd](#gcd) +- [get_high_word](#get_high_word) +- [hypot](#hypot) +- [ilog_b](#ilog_b) +- [inf](#inf) +- [is_finite](#is_finite) +- [is_inf](#is_inf) +- [is_nan](#is_nan) +- [lcm](#lcm) +- [ldexp](#ldexp) +- [log](#log) +- [log10](#log10) +- [log1p](#log1p) +- [log2](#log2) +- [log_b](#log_b) +- [log_factorial](#log_factorial) +- [log_gamma](#log_gamma) +- [log_gamma_sign](#log_gamma_sign) +- [log_n](#log_n) +- [logf](#logf) +- [max](#max) +- [maxof](#maxof) +- [min](#min) +- [minmax](#minmax) +- [minof](#minof) +- [mix](#mix) +- [mod](#mod) +- [modf](#modf) +- [modulo_euclid](#modulo_euclid) +- [modulo_floored](#modulo_floored) +- [modulo_truncated](#modulo_truncated) +- [nan](#nan) +- [nextafter](#nextafter) +- [nextafter32](#nextafter32) +- [normalize](#normalize) +- [pow](#pow) +- [pow10](#pow10) +- [powf](#powf) +- [powi](#powi) +- [q_rsqrt](#q_rsqrt) +- [radians](#radians) +- [round](#round) +- [round_sig](#round_sig) +- [round_to_even](#round_to_even) +- [scalbn](#scalbn) +- [sign](#sign) +- [signbit](#signbit) +- [signi](#signi) +- [sin](#sin) +- [sincos](#sincos) +- [sinf](#sinf) +- [sinh](#sinh) +- [sqrt](#sqrt) +- [sqrtf](#sqrtf) +- [sqrti](#sqrti) +- [square](#square) +- [tan](#tan) +- [tanf](#tanf) +- [tanh](#tanh) +- [tolerance](#tolerance) +- [trunc](#trunc) +- [veryclose](#veryclose) +- [with_set_high_word](#with_set_high_word) +- [with_set_low_word](#with_set_low_word) +- [BezierPoint](#BezierPoint) +- [DigitParams](#DigitParams) +- [DivResult](#DivResult) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## abs +[[Return to contents]](#Contents) + +## acos +[[Return to contents]](#Contents) + +## acosh +[[Return to contents]](#Contents) + +## alike +[[Return to contents]](#Contents) + +## angle_diff +[[Return to contents]](#Contents) + +## aprox_cos +[[Return to contents]](#Contents) + +## aprox_sin +[[Return to contents]](#Contents) + +## asin +[[Return to contents]](#Contents) + +## asinh +[[Return to contents]](#Contents) + +## atan +[[Return to contents]](#Contents) + +## atan2 +[[Return to contents]](#Contents) + +## atanh +[[Return to contents]](#Contents) + +## cbrt +[[Return to contents]](#Contents) + +## ceil +[[Return to contents]](#Contents) + +## clamp +[[Return to contents]](#Contents) + +## clip +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## copysign +[[Return to contents]](#Contents) + +## cos +[[Return to contents]](#Contents) + +## cosf +[[Return to contents]](#Contents) + +## cosh +[[Return to contents]](#Contents) + +## cot +[[Return to contents]](#Contents) + +## count_digits +[[Return to contents]](#Contents) + +## cube +[[Return to contents]](#Contents) + +## cubic_bezier +[[Return to contents]](#Contents) + +## cubic_bezier_a +[[Return to contents]](#Contents) + +## cubic_bezier_coords +[[Return to contents]](#Contents) + +## cubic_bezier_fa +[[Return to contents]](#Contents) + +## degrees +[[Return to contents]](#Contents) + +## digits +Examples +```v + +assert math.digits(12345, base: 10) == [5,4,3,2,1] + +assert math.digits(12345, reverse: true) == [1,2,3,4,5] + +``` + +[[Return to contents]](#Contents) + +## divide_euclid +[[Return to contents]](#Contents) + +## divide_floored +[[Return to contents]](#Contents) + +## divide_truncated +[[Return to contents]](#Contents) + +## egcd +[[Return to contents]](#Contents) + +## erf +[[Return to contents]](#Contents) + +## erfc +[[Return to contents]](#Contents) + +## exp +[[Return to contents]](#Contents) + +## exp2 +[[Return to contents]](#Contents) + +## expm1 +[[Return to contents]](#Contents) + +## f32_bits +[[Return to contents]](#Contents) + +## f32_from_bits +[[Return to contents]](#Contents) + +## f64_bits +[[Return to contents]](#Contents) + +## f64_from_bits +[[Return to contents]](#Contents) + +## factorial +[[Return to contents]](#Contents) + +## factoriali +[[Return to contents]](#Contents) + +## floor +[[Return to contents]](#Contents) + +## floorf +[[Return to contents]](#Contents) + +## fmod +[[Return to contents]](#Contents) + +## frexp +[[Return to contents]](#Contents) + +## gamma +[[Return to contents]](#Contents) + +## gcd +[[Return to contents]](#Contents) + +## get_high_word +[[Return to contents]](#Contents) + +## hypot +[[Return to contents]](#Contents) + +## ilog_b +[[Return to contents]](#Contents) + +## inf +[[Return to contents]](#Contents) + +## is_finite +[[Return to contents]](#Contents) + +## is_inf +[[Return to contents]](#Contents) + +## is_nan +[[Return to contents]](#Contents) + +## lcm +[[Return to contents]](#Contents) + +## ldexp +[[Return to contents]](#Contents) + +## log +[[Return to contents]](#Contents) + +## log10 +[[Return to contents]](#Contents) + +## log1p +[[Return to contents]](#Contents) + +## log2 +[[Return to contents]](#Contents) + +## log_b +[[Return to contents]](#Contents) + +## log_factorial +[[Return to contents]](#Contents) + +## log_gamma +[[Return to contents]](#Contents) + +## log_gamma_sign +[[Return to contents]](#Contents) + +## log_n +[[Return to contents]](#Contents) + +## logf +[[Return to contents]](#Contents) + +## max +[[Return to contents]](#Contents) + +## maxof +[[Return to contents]](#Contents) + +## min +[[Return to contents]](#Contents) + +## minmax +[[Return to contents]](#Contents) + +## minof +[[Return to contents]](#Contents) + +## mix +[[Return to contents]](#Contents) + +## mod +[[Return to contents]](#Contents) + +## modf +[[Return to contents]](#Contents) + +## modulo_euclid +[[Return to contents]](#Contents) + +## modulo_floored +[[Return to contents]](#Contents) + +## modulo_truncated +[[Return to contents]](#Contents) + +## nan +[[Return to contents]](#Contents) + +## nextafter +[[Return to contents]](#Contents) + +## nextafter32 +[[Return to contents]](#Contents) + +## normalize +[[Return to contents]](#Contents) + +## pow +[[Return to contents]](#Contents) + +## pow10 +[[Return to contents]](#Contents) + +## powf +[[Return to contents]](#Contents) + +## powi +[[Return to contents]](#Contents) + +## q_rsqrt +[[Return to contents]](#Contents) + +## radians +[[Return to contents]](#Contents) + +## round +[[Return to contents]](#Contents) + +## round_sig +[[Return to contents]](#Contents) + +## round_to_even +[[Return to contents]](#Contents) + +## scalbn +[[Return to contents]](#Contents) + +## sign +[[Return to contents]](#Contents) + +## signbit +[[Return to contents]](#Contents) + +## signi +[[Return to contents]](#Contents) + +## sin +[[Return to contents]](#Contents) + +## sincos +[[Return to contents]](#Contents) + +## sinf +[[Return to contents]](#Contents) + +## sinh +[[Return to contents]](#Contents) + +## sqrt +[[Return to contents]](#Contents) + +## sqrtf +[[Return to contents]](#Contents) + +## sqrti +[[Return to contents]](#Contents) + +## square +[[Return to contents]](#Contents) + +## tan +[[Return to contents]](#Contents) + +## tanf +[[Return to contents]](#Contents) + +## tanh +[[Return to contents]](#Contents) + +## tolerance +[[Return to contents]](#Contents) + +## trunc +[[Return to contents]](#Contents) + +## veryclose +[[Return to contents]](#Contents) + +## with_set_high_word +[[Return to contents]](#Contents) + +## with_set_low_word +[[Return to contents]](#Contents) + +## BezierPoint +[[Return to contents]](#Contents) + +## DigitParams +[[Return to contents]](#Contents) + +## DivResult +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.stats.md b/vdocs/math.stats.md new file mode 100644 index 00000000..70f237cf --- /dev/null +++ b/vdocs/math.stats.md @@ -0,0 +1,146 @@ +# module math.stats + + +## Contents +- [absdev](#absdev) +- [absdev_mean](#absdev_mean) +- [covariance](#covariance) +- [covariance_mean](#covariance_mean) +- [freq](#freq) +- [geometric_mean](#geometric_mean) +- [harmonic_mean](#harmonic_mean) +- [kurtosis](#kurtosis) +- [kurtosis_mean_stddev](#kurtosis_mean_stddev) +- [lag1_autocorrelation](#lag1_autocorrelation) +- [lag1_autocorrelation_mean](#lag1_autocorrelation_mean) +- [max](#max) +- [max_index](#max_index) +- [mean](#mean) +- [median](#median) +- [min](#min) +- [min_index](#min_index) +- [minmax](#minmax) +- [minmax_index](#minmax_index) +- [mode](#mode) +- [population_stddev](#population_stddev) +- [population_stddev_mean](#population_stddev_mean) +- [population_variance](#population_variance) +- [population_variance_mean](#population_variance_mean) +- [quantile](#quantile) +- [range](#range) +- [rms](#rms) +- [sample_stddev](#sample_stddev) +- [sample_stddev_mean](#sample_stddev_mean) +- [sample_variance](#sample_variance) +- [sample_variance_mean](#sample_variance_mean) +- [skew](#skew) +- [skew_mean_stddev](#skew_mean_stddev) +- [tss](#tss) +- [tss_mean](#tss_mean) + +## absdev +[[Return to contents]](#Contents) + +## absdev_mean +[[Return to contents]](#Contents) + +## covariance +[[Return to contents]](#Contents) + +## covariance_mean +[[Return to contents]](#Contents) + +## freq +[[Return to contents]](#Contents) + +## geometric_mean +[[Return to contents]](#Contents) + +## harmonic_mean +[[Return to contents]](#Contents) + +## kurtosis +[[Return to contents]](#Contents) + +## kurtosis_mean_stddev +[[Return to contents]](#Contents) + +## lag1_autocorrelation +[[Return to contents]](#Contents) + +## lag1_autocorrelation_mean +[[Return to contents]](#Contents) + +## max +[[Return to contents]](#Contents) + +## max_index +[[Return to contents]](#Contents) + +## mean +[[Return to contents]](#Contents) + +## median +[[Return to contents]](#Contents) + +## min +[[Return to contents]](#Contents) + +## min_index +[[Return to contents]](#Contents) + +## minmax +[[Return to contents]](#Contents) + +## minmax_index +[[Return to contents]](#Contents) + +## mode +[[Return to contents]](#Contents) + +## population_stddev +[[Return to contents]](#Contents) + +## population_stddev_mean +[[Return to contents]](#Contents) + +## population_variance +[[Return to contents]](#Contents) + +## population_variance_mean +[[Return to contents]](#Contents) + +## quantile +[[Return to contents]](#Contents) + +## range +[[Return to contents]](#Contents) + +## rms +[[Return to contents]](#Contents) + +## sample_stddev +[[Return to contents]](#Contents) + +## sample_stddev_mean +[[Return to contents]](#Contents) + +## sample_variance +[[Return to contents]](#Contents) + +## sample_variance_mean +[[Return to contents]](#Contents) + +## skew +[[Return to contents]](#Contents) + +## skew_mean_stddev +[[Return to contents]](#Contents) + +## tss +[[Return to contents]](#Contents) + +## tss_mean +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.unsigned.md b/vdocs/math.unsigned.md new file mode 100644 index 00000000..3be674d6 --- /dev/null +++ b/vdocs/math.unsigned.md @@ -0,0 +1,420 @@ +# module math.unsigned + + +## Contents +- [Constants](#Constants) +- [add_128](#add_128) +- [add_256](#add_256) +- [div_128](#div_128) +- [mul_128](#mul_128) +- [mul_256](#mul_256) +- [sub_128](#sub_128) +- [sub_256](#sub_256) +- [uint128_from_64](#uint128_from_64) +- [uint128_from_dec_str](#uint128_from_dec_str) +- [uint128_new](#uint128_new) +- [uint256_from_128](#uint256_from_128) +- [uint256_from_64](#uint256_from_64) +- [uint256_from_dec_str](#uint256_from_dec_str) +- [Uint128](#Uint128) + - [is_zero](#is_zero) + - [equals](#equals) + - [equals_64](#equals_64) + - [cmp](#cmp) + - [cmp_64](#cmp_64) + - [and](#and) + - [and_64](#and_64) + - [or_](#or_) + - [or_64](#or_64) + - [xor](#xor) + - [xor_64](#xor_64) + - [add](#add) + - [add_64](#add_64) + - [sub](#sub) + - [sub_64](#sub_64) + - [mul](#mul) + - [mul_64](#mul_64) + - [overflowing_mul_64](#overflowing_mul_64) + - [overflowing_add_64](#overflowing_add_64) + - [div](#div) + - [mod](#mod) + - [mod_64](#mod_64) + - [quo_rem_64](#quo_rem_64) + - [quo_rem](#quo_rem) + - [lsh](#lsh) + - [rsh](#rsh) + - [leading_zeros](#leading_zeros) + - [trailing_zeros](#trailing_zeros) + - [ones_count](#ones_count) + - [rotate_left](#rotate_left) + - [rotate_right](#rotate_right) + - [reverse](#reverse) + - [reverse_bytes](#reverse_bytes) + - [not](#not) + - [len](#len) + - [str](#str) + - [put_bytes](#put_bytes) + - [/](#/) + - [%](#%) + - [+](#+) + - [-](#-) + - [*](#*) + - [<](#<) +- [Uint256](#Uint256) + - [is_zero](#is_zero) + - [equals](#equals) + - [equals_128](#equals_128) + - [cmp](#cmp) + - [cmp_128](#cmp_128) + - [not](#not) + - [and](#and) + - [and_128](#and_128) + - [or_](#or_) + - [or_128](#or_128) + - [xor](#xor) + - [xor_128](#xor_128) + - [add](#add) + - [overflowing_add](#overflowing_add) + - [add_128](#add_128) + - [sub](#sub) + - [sub_128](#sub_128) + - [mul](#mul) + - [mul_128](#mul_128) + - [quo_rem](#quo_rem) + - [quo_rem_128](#quo_rem_128) + - [quo_rem_64](#quo_rem_64) + - [rsh](#rsh) + - [lsh](#lsh) + - [div](#div) + - [div_128](#div_128) + - [div_64](#div_64) + - [mod](#mod) + - [mod_128](#mod_128) + - [mod_64](#mod_64) + - [rotate_left](#rotate_left) + - [rotate_right](#rotate_right) + - [len](#len) + - [leading_zeros](#leading_zeros) + - [trailing_zeros](#trailing_zeros) + - [ones_count](#ones_count) + - [str](#str) + - [/](#/) + - [%](#%) + - [+](#+) + - [-](#-) + - [*](#*) + - [<](#<) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## add_128 +[[Return to contents]](#Contents) + +## add_256 +[[Return to contents]](#Contents) + +## div_128 +[[Return to contents]](#Contents) + +## mul_128 +[[Return to contents]](#Contents) + +## mul_256 +[[Return to contents]](#Contents) + +## sub_128 +[[Return to contents]](#Contents) + +## sub_256 +[[Return to contents]](#Contents) + +## uint128_from_64 +[[Return to contents]](#Contents) + +## uint128_from_dec_str +[[Return to contents]](#Contents) + +## uint128_new +[[Return to contents]](#Contents) + +## uint256_from_128 +[[Return to contents]](#Contents) + +## uint256_from_64 +[[Return to contents]](#Contents) + +## uint256_from_dec_str +[[Return to contents]](#Contents) + +## Uint128 +[[Return to contents]](#Contents) + +## is_zero +[[Return to contents]](#Contents) + +## equals +[[Return to contents]](#Contents) + +## equals_64 +[[Return to contents]](#Contents) + +## cmp +[[Return to contents]](#Contents) + +## cmp_64 +[[Return to contents]](#Contents) + +## and +[[Return to contents]](#Contents) + +## and_64 +[[Return to contents]](#Contents) + +## or_ +[[Return to contents]](#Contents) + +## or_64 +[[Return to contents]](#Contents) + +## xor +[[Return to contents]](#Contents) + +## xor_64 +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add_64 +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## sub_64 +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## mul_64 +[[Return to contents]](#Contents) + +## overflowing_mul_64 +[[Return to contents]](#Contents) + +## overflowing_add_64 +[[Return to contents]](#Contents) + +## div +[[Return to contents]](#Contents) + +## mod +[[Return to contents]](#Contents) + +## mod_64 +[[Return to contents]](#Contents) + +## quo_rem_64 +[[Return to contents]](#Contents) + +## quo_rem +[[Return to contents]](#Contents) + +## lsh +[[Return to contents]](#Contents) + +## rsh +[[Return to contents]](#Contents) + +## leading_zeros +[[Return to contents]](#Contents) + +## trailing_zeros +[[Return to contents]](#Contents) + +## ones_count +[[Return to contents]](#Contents) + +## rotate_left +[[Return to contents]](#Contents) + +## rotate_right +[[Return to contents]](#Contents) + +## reverse +[[Return to contents]](#Contents) + +## reverse_bytes +[[Return to contents]](#Contents) + +## not +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## put_bytes +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## % +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## < +[[Return to contents]](#Contents) + +## Uint256 +[[Return to contents]](#Contents) + +## is_zero +[[Return to contents]](#Contents) + +## equals +[[Return to contents]](#Contents) + +## equals_128 +[[Return to contents]](#Contents) + +## cmp +[[Return to contents]](#Contents) + +## cmp_128 +[[Return to contents]](#Contents) + +## not +[[Return to contents]](#Contents) + +## and +[[Return to contents]](#Contents) + +## and_128 +[[Return to contents]](#Contents) + +## or_ +[[Return to contents]](#Contents) + +## or_128 +[[Return to contents]](#Contents) + +## xor +[[Return to contents]](#Contents) + +## xor_128 +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## overflowing_add +[[Return to contents]](#Contents) + +## add_128 +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## sub_128 +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## mul_128 +[[Return to contents]](#Contents) + +## quo_rem +[[Return to contents]](#Contents) + +## quo_rem_128 +[[Return to contents]](#Contents) + +## quo_rem_64 +[[Return to contents]](#Contents) + +## rsh +[[Return to contents]](#Contents) + +## lsh +[[Return to contents]](#Contents) + +## div +[[Return to contents]](#Contents) + +## div_128 +[[Return to contents]](#Contents) + +## div_64 +[[Return to contents]](#Contents) + +## mod +[[Return to contents]](#Contents) + +## mod_128 +[[Return to contents]](#Contents) + +## mod_64 +[[Return to contents]](#Contents) + +## rotate_left +[[Return to contents]](#Contents) + +## rotate_right +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## leading_zeros +[[Return to contents]](#Contents) + +## trailing_zeros +[[Return to contents]](#Contents) + +## ones_count +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## % +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## < +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/math.vec.md b/vdocs/math.vec.md new file mode 100644 index 00000000..255772fa --- /dev/null +++ b/vdocs/math.vec.md @@ -0,0 +1,652 @@ +# module math.vec + + +## Contents +- [Constants](#Constants) +- [vec2](#vec2) +- [vec3](#vec3) +- [vec4](#vec4) +- [Vec2[T]](#Vec2[T]) + - [zero](#zero) + - [one](#one) + - [copy](#copy) + - [from](#from) + - [from_vec3](#from_vec3) + - [as_vec3](#as_vec3) + - [from_vec4](#from_vec4) + - [as_vec4](#as_vec4) + - [+](#+) + - [add](#add) + - [add_scalar](#add_scalar) + - [plus](#plus) + - [plus_scalar](#plus_scalar) + - [-](#-) + - [sub](#sub) + - [sub_scalar](#sub_scalar) + - [subtract](#subtract) + - [subtract_scalar](#subtract_scalar) + - [*](#*) + - [mul](#mul) + - [mul_scalar](#mul_scalar) + - [multiply](#multiply) + - [multiply_scalar](#multiply_scalar) + - [/](#/) + - [div](#div) + - [div_scalar](#div_scalar) + - [divide](#divide) + - [divide_scalar](#divide_scalar) + - [magnitude](#magnitude) + - [magnitude_x](#magnitude_x) + - [magnitude_y](#magnitude_y) + - [dot](#dot) + - [cross](#cross) + - [unit](#unit) + - [perp_cw](#perp_cw) + - [perp_ccw](#perp_ccw) + - [perpendicular](#perpendicular) + - [project](#project) + - [eq](#eq) + - [eq_epsilon](#eq_epsilon) + - [eq_approx](#eq_approx) + - [is_approx_zero](#is_approx_zero) + - [eq_scalar](#eq_scalar) + - [distance](#distance) + - [manhattan_distance](#manhattan_distance) + - [angle_between](#angle_between) + - [angle_towards](#angle_towards) + - [angle](#angle) + - [abs](#abs) + - [clean](#clean) + - [clean_tolerance](#clean_tolerance) + - [inv](#inv) + - [normalize](#normalize) + - [sum](#sum) +- [Vec3[T]](#Vec3[T]) + - [zero](#zero) + - [one](#one) + - [copy](#copy) + - [from](#from) + - [from_vec2](#from_vec2) + - [as_vec2](#as_vec2) + - [from_vec4](#from_vec4) + - [as_vec4](#as_vec4) + - [+](#+) + - [add](#add) + - [add_vec2](#add_vec2) + - [add_scalar](#add_scalar) + - [plus](#plus) + - [plus_vec2](#plus_vec2) + - [plus_scalar](#plus_scalar) + - [-](#-) + - [sub](#sub) + - [sub_scalar](#sub_scalar) + - [subtract](#subtract) + - [subtract_scalar](#subtract_scalar) + - [*](#*) + - [mul](#mul) + - [mul_scalar](#mul_scalar) + - [multiply](#multiply) + - [multiply_scalar](#multiply_scalar) + - [/](#/) + - [div](#div) + - [div_scalar](#div_scalar) + - [divide](#divide) + - [divide_scalar](#divide_scalar) + - [magnitude](#magnitude) + - [dot](#dot) + - [cross](#cross) + - [unit](#unit) + - [perpendicular](#perpendicular) + - [project](#project) + - [eq](#eq) + - [eq_epsilon](#eq_epsilon) + - [eq_approx](#eq_approx) + - [is_approx_zero](#is_approx_zero) + - [eq_scalar](#eq_scalar) + - [distance](#distance) + - [manhattan_distance](#manhattan_distance) + - [angle_between](#angle_between) + - [abs](#abs) + - [clean](#clean) + - [clean_tolerance](#clean_tolerance) + - [inv](#inv) + - [normalize](#normalize) + - [sum](#sum) +- [Vec4[T]](#Vec4[T]) + - [zero](#zero) + - [one](#one) + - [copy](#copy) + - [from](#from) + - [from_vec2](#from_vec2) + - [as_vec2](#as_vec2) + - [from_vec3](#from_vec3) + - [as_vec3](#as_vec3) + - [+](#+) + - [add](#add) + - [add_vec2](#add_vec2) + - [add_vec3](#add_vec3) + - [add_scalar](#add_scalar) + - [plus](#plus) + - [plus_scalar](#plus_scalar) + - [-](#-) + - [sub](#sub) + - [sub_scalar](#sub_scalar) + - [subtract](#subtract) + - [subtract_scalar](#subtract_scalar) + - [*](#*) + - [mul](#mul) + - [mul_scalar](#mul_scalar) + - [multiply](#multiply) + - [multiply_scalar](#multiply_scalar) + - [/](#/) + - [div](#div) + - [div_scalar](#div_scalar) + - [divide](#divide) + - [divide_scalar](#divide_scalar) + - [magnitude](#magnitude) + - [dot](#dot) + - [cross_xyz](#cross_xyz) + - [unit](#unit) + - [perpendicular](#perpendicular) + - [project](#project) + - [eq](#eq) + - [eq_epsilon](#eq_epsilon) + - [eq_approx](#eq_approx) + - [is_approx_zero](#is_approx_zero) + - [eq_scalar](#eq_scalar) + - [distance](#distance) + - [manhattan_distance](#manhattan_distance) + - [abs](#abs) + - [clean](#clean) + - [clean_tolerance](#clean_tolerance) + - [inv](#inv) + - [normalize](#normalize) + - [sum](#sum) +- [Vec2](#Vec2) +- [Vec3](#Vec3) +- [Vec4](#Vec4) + +## Constants +[[Return to contents]](#Contents) + +## vec2 +[[Return to contents]](#Contents) + +## vec3 +[[Return to contents]](#Contents) + +## vec4 +[[Return to contents]](#Contents) + +## Vec2[T] +## zero +[[Return to contents]](#Contents) + +## one +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## from +[[Return to contents]](#Contents) + +## from_vec3 +[[Return to contents]](#Contents) + +## as_vec3 +[[Return to contents]](#Contents) + +## from_vec4 +[[Return to contents]](#Contents) + +## as_vec4 +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add_scalar +[[Return to contents]](#Contents) + +## plus +[[Return to contents]](#Contents) + +## plus_scalar +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## sub_scalar +[[Return to contents]](#Contents) + +## subtract +[[Return to contents]](#Contents) + +## subtract_scalar +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## mul_scalar +[[Return to contents]](#Contents) + +## multiply +[[Return to contents]](#Contents) + +## multiply_scalar +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## div +[[Return to contents]](#Contents) + +## div_scalar +[[Return to contents]](#Contents) + +## divide +[[Return to contents]](#Contents) + +## divide_scalar +[[Return to contents]](#Contents) + +## magnitude +[[Return to contents]](#Contents) + +## magnitude_x +[[Return to contents]](#Contents) + +## magnitude_y +[[Return to contents]](#Contents) + +## dot +[[Return to contents]](#Contents) + +## cross +[[Return to contents]](#Contents) + +## unit +[[Return to contents]](#Contents) + +## perp_cw +[[Return to contents]](#Contents) + +## perp_ccw +[[Return to contents]](#Contents) + +## perpendicular +[[Return to contents]](#Contents) + +## project +[[Return to contents]](#Contents) + +## eq +[[Return to contents]](#Contents) + +## eq_epsilon +[[Return to contents]](#Contents) + +## eq_approx +[[Return to contents]](#Contents) + +## is_approx_zero +[[Return to contents]](#Contents) + +## eq_scalar +[[Return to contents]](#Contents) + +## distance +[[Return to contents]](#Contents) + +## manhattan_distance +[[Return to contents]](#Contents) + +## angle_between +[[Return to contents]](#Contents) + +## angle_towards +[[Return to contents]](#Contents) + +## angle +[[Return to contents]](#Contents) + +## abs +[[Return to contents]](#Contents) + +## clean +[[Return to contents]](#Contents) + +## clean_tolerance +[[Return to contents]](#Contents) + +## inv +[[Return to contents]](#Contents) + +## normalize +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## Vec3[T] +## zero +[[Return to contents]](#Contents) + +## one +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## from +[[Return to contents]](#Contents) + +## from_vec2 +[[Return to contents]](#Contents) + +## as_vec2 +[[Return to contents]](#Contents) + +## from_vec4 +[[Return to contents]](#Contents) + +## as_vec4 +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add_vec2 +[[Return to contents]](#Contents) + +## add_scalar +[[Return to contents]](#Contents) + +## plus +[[Return to contents]](#Contents) + +## plus_vec2 +[[Return to contents]](#Contents) + +## plus_scalar +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## sub_scalar +[[Return to contents]](#Contents) + +## subtract +[[Return to contents]](#Contents) + +## subtract_scalar +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## mul_scalar +[[Return to contents]](#Contents) + +## multiply +[[Return to contents]](#Contents) + +## multiply_scalar +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## div +[[Return to contents]](#Contents) + +## div_scalar +[[Return to contents]](#Contents) + +## divide +[[Return to contents]](#Contents) + +## divide_scalar +[[Return to contents]](#Contents) + +## magnitude +[[Return to contents]](#Contents) + +## dot +[[Return to contents]](#Contents) + +## cross +[[Return to contents]](#Contents) + +## unit +[[Return to contents]](#Contents) + +## perpendicular +[[Return to contents]](#Contents) + +## project +[[Return to contents]](#Contents) + +## eq +[[Return to contents]](#Contents) + +## eq_epsilon +[[Return to contents]](#Contents) + +## eq_approx +[[Return to contents]](#Contents) + +## is_approx_zero +[[Return to contents]](#Contents) + +## eq_scalar +[[Return to contents]](#Contents) + +## distance +[[Return to contents]](#Contents) + +## manhattan_distance +[[Return to contents]](#Contents) + +## angle_between +[[Return to contents]](#Contents) + +## abs +[[Return to contents]](#Contents) + +## clean +[[Return to contents]](#Contents) + +## clean_tolerance +[[Return to contents]](#Contents) + +## inv +[[Return to contents]](#Contents) + +## normalize +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## Vec4[T] +## zero +[[Return to contents]](#Contents) + +## one +[[Return to contents]](#Contents) + +## copy +[[Return to contents]](#Contents) + +## from +[[Return to contents]](#Contents) + +## from_vec2 +[[Return to contents]](#Contents) + +## as_vec2 +[[Return to contents]](#Contents) + +## from_vec3 +[[Return to contents]](#Contents) + +## as_vec3 +[[Return to contents]](#Contents) + +## + +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add_vec2 +[[Return to contents]](#Contents) + +## add_vec3 +[[Return to contents]](#Contents) + +## add_scalar +[[Return to contents]](#Contents) + +## plus +[[Return to contents]](#Contents) + +## plus_scalar +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## sub_scalar +[[Return to contents]](#Contents) + +## subtract +[[Return to contents]](#Contents) + +## subtract_scalar +[[Return to contents]](#Contents) + +## * +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## mul_scalar +[[Return to contents]](#Contents) + +## multiply +[[Return to contents]](#Contents) + +## multiply_scalar +[[Return to contents]](#Contents) + +## / +[[Return to contents]](#Contents) + +## div +[[Return to contents]](#Contents) + +## div_scalar +[[Return to contents]](#Contents) + +## divide +[[Return to contents]](#Contents) + +## divide_scalar +[[Return to contents]](#Contents) + +## magnitude +[[Return to contents]](#Contents) + +## dot +[[Return to contents]](#Contents) + +## cross_xyz +[[Return to contents]](#Contents) + +## unit +[[Return to contents]](#Contents) + +## perpendicular +[[Return to contents]](#Contents) + +## project +[[Return to contents]](#Contents) + +## eq +[[Return to contents]](#Contents) + +## eq_epsilon +[[Return to contents]](#Contents) + +## eq_approx +[[Return to contents]](#Contents) + +## is_approx_zero +[[Return to contents]](#Contents) + +## eq_scalar +[[Return to contents]](#Contents) + +## distance +[[Return to contents]](#Contents) + +## manhattan_distance +[[Return to contents]](#Contents) + +## abs +[[Return to contents]](#Contents) + +## clean +[[Return to contents]](#Contents) + +## clean_tolerance +[[Return to contents]](#Contents) + +## inv +[[Return to contents]](#Contents) + +## normalize +[[Return to contents]](#Contents) + +## sum +[[Return to contents]](#Contents) + +## Vec2 +[[Return to contents]](#Contents) + +## Vec3 +[[Return to contents]](#Contents) + +## Vec4 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.conv.md b/vdocs/net.conv.md new file mode 100644 index 00000000..b136a992 --- /dev/null +++ b/vdocs/net.conv.md @@ -0,0 +1,58 @@ +# module net.conv + + +## Contents +- [hton16](#hton16) +- [hton32](#hton32) +- [hton64](#hton64) +- [htonf32](#htonf32) +- [htonf64](#htonf64) +- [ntoh16](#ntoh16) +- [ntoh32](#ntoh32) +- [ntoh64](#ntoh64) +- [reverse_bytes_u16](#reverse_bytes_u16) +- [reverse_bytes_u32](#reverse_bytes_u32) +- [reverse_bytes_u64](#reverse_bytes_u64) +- [u64tovarint](#u64tovarint) +- [varinttou64](#varinttou64) + +## hton16 +[[Return to contents]](#Contents) + +## hton32 +[[Return to contents]](#Contents) + +## hton64 +[[Return to contents]](#Contents) + +## htonf32 +[[Return to contents]](#Contents) + +## htonf64 +[[Return to contents]](#Contents) + +## ntoh16 +[[Return to contents]](#Contents) + +## ntoh32 +[[Return to contents]](#Contents) + +## ntoh64 +[[Return to contents]](#Contents) + +## reverse_bytes_u16 +[[Return to contents]](#Contents) + +## reverse_bytes_u32 +[[Return to contents]](#Contents) + +## reverse_bytes_u64 +[[Return to contents]](#Contents) + +## u64tovarint +[[Return to contents]](#Contents) + +## varinttou64 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.ftp.md b/vdocs/net.ftp.md new file mode 100644 index 00000000..4494ccca --- /dev/null +++ b/vdocs/net.ftp.md @@ -0,0 +1,40 @@ +# module net.ftp + + +## Contents +- [new](#new) +- [FTP](#FTP) + - [connect](#connect) + - [login](#login) + - [close](#close) + - [pwd](#pwd) + - [cd](#cd) + - [dir](#dir) + - [get](#get) + +## new +[[Return to contents]](#Contents) + +## FTP +## connect +[[Return to contents]](#Contents) + +## login +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## pwd +[[Return to contents]](#Contents) + +## cd +[[Return to contents]](#Contents) + +## dir +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.html.md b/vdocs/net.html.md new file mode 100644 index 00000000..cc82af47 --- /dev/null +++ b/vdocs/net.html.md @@ -0,0 +1,114 @@ +# module net.html + + +## Contents +- [parse](#parse) +- [parse_file](#parse_file) +- [CloseTagType](#CloseTagType) +- [DocumentObjectModel](#DocumentObjectModel) + - [get_root](#get_root) + - [get_tags](#get_tags) + - [get_tags_by_class_name](#get_tags_by_class_name) + - [get_tags_by_attribute](#get_tags_by_attribute) + - [get_tags_by_attribute_value](#get_tags_by_attribute_value) +- [GetTagsOptions](#GetTagsOptions) +- [Parser](#Parser) + - [add_code_tag](#add_code_tag) + - [split_parse](#split_parse) + - [parse_html](#parse_html) + - [finalize](#finalize) + - [get_dom](#get_dom) +- [Tag](#Tag) + - [text](#text) + - [str](#str) + - [get_tag](#get_tag) + - [get_tags](#get_tags) + - [get_tag_by_attribute](#get_tag_by_attribute) + - [get_tags_by_attribute](#get_tags_by_attribute) + - [get_tag_by_attribute_value](#get_tag_by_attribute_value) + - [get_tags_by_attribute_value](#get_tags_by_attribute_value) + - [get_tag_by_class_name](#get_tag_by_class_name) + - [get_tags_by_class_name](#get_tags_by_class_name) + +## parse +[[Return to contents]](#Contents) + +## parse_file +[[Return to contents]](#Contents) + +## CloseTagType +[[Return to contents]](#Contents) + +## DocumentObjectModel +[[Return to contents]](#Contents) + +## get_root +[[Return to contents]](#Contents) + +## get_tags +[[Return to contents]](#Contents) + +## get_tags_by_class_name +[[Return to contents]](#Contents) + +## get_tags_by_attribute +[[Return to contents]](#Contents) + +## get_tags_by_attribute_value +[[Return to contents]](#Contents) + +## GetTagsOptions +[[Return to contents]](#Contents) + +## Parser +[[Return to contents]](#Contents) + +## add_code_tag +[[Return to contents]](#Contents) + +## split_parse +[[Return to contents]](#Contents) + +## parse_html +[[Return to contents]](#Contents) + +## finalize +[[Return to contents]](#Contents) + +## get_dom +[[Return to contents]](#Contents) + +## Tag +[[Return to contents]](#Contents) + +## text +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## get_tag +[[Return to contents]](#Contents) + +## get_tags +[[Return to contents]](#Contents) + +## get_tag_by_attribute +[[Return to contents]](#Contents) + +## get_tags_by_attribute +[[Return to contents]](#Contents) + +## get_tag_by_attribute_value +[[Return to contents]](#Contents) + +## get_tags_by_attribute_value +[[Return to contents]](#Contents) + +## get_tag_by_class_name +[[Return to contents]](#Contents) + +## get_tags_by_class_name +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.http.chunked.md b/vdocs/net.http.chunked.md new file mode 100644 index 00000000..41074879 --- /dev/null +++ b/vdocs/net.http.chunked.md @@ -0,0 +1,10 @@ +# module net.http.chunked + + +## Contents +- [decode](#decode) + +## decode +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.http.file.md b/vdocs/net.http.file.md new file mode 100644 index 00000000..ecee86d5 --- /dev/null +++ b/vdocs/net.http.file.md @@ -0,0 +1,18 @@ +# module net.http.file + + +## Contents +- [serve](#serve) +- [Entity](#Entity) +- [StaticServeParams](#StaticServeParams) + +## serve +[[Return to contents]](#Contents) + +## Entity +[[Return to contents]](#Contents) + +## StaticServeParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.http.md b/vdocs/net.http.md new file mode 100644 index 00000000..3eb8844f --- /dev/null +++ b/vdocs/net.http.md @@ -0,0 +1,514 @@ +# module net.http + + +## Contents +- [Constants](#Constants) +- [delete](#delete) +- [download_file](#download_file) +- [download_file_with_cookies](#download_file_with_cookies) +- [download_file_with_progress](#download_file_with_progress) +- [fetch](#fetch) +- [get](#get) +- [get_text](#get_text) +- [head](#head) +- [is_cookie_domain_name](#is_cookie_domain_name) +- [method_from_str](#method_from_str) +- [new_custom_header_from_map](#new_custom_header_from_map) +- [new_header](#new_header) +- [new_header_from_map](#new_header_from_map) +- [new_http_proxy](#new_http_proxy) +- [new_request](#new_request) +- [new_response](#new_response) +- [parse_form](#parse_form) +- [parse_multipart_form](#parse_multipart_form) +- [parse_request](#parse_request) +- [parse_request_head](#parse_request_head) +- [parse_response](#parse_response) +- [patch](#patch) +- [post](#post) +- [post_form](#post_form) +- [post_form_with_cookies](#post_form_with_cookies) +- [post_json](#post_json) +- [post_multipart_form](#post_multipart_form) +- [prepare](#prepare) +- [put](#put) +- [read_cookies](#read_cookies) +- [sanitize_cookie_value](#sanitize_cookie_value) +- [status_from_int](#status_from_int) +- [url_encode_form_data](#url_encode_form_data) +- [version_from_str](#version_from_str) +- [Downloader](#Downloader) +- [Handler](#Handler) +- [HeaderKeyError](#HeaderKeyError) + - [msg](#msg) + - [code](#code) +- [RequestFinishFn](#RequestFinishFn) +- [RequestProgressBodyFn](#RequestProgressBodyFn) +- [RequestProgressFn](#RequestProgressFn) +- [RequestRedirectFn](#RequestRedirectFn) +- [CommonHeader](#CommonHeader) + - [str](#str) +- [Method](#Method) + - [str](#str) +- [SameSite](#SameSite) +- [ServerStatus](#ServerStatus) +- [Status](#Status) + - [str](#str) + - [int](#int) + - [is_valid](#is_valid) + - [is_error](#is_error) + - [is_success](#is_success) +- [Version](#Version) + - [str](#str) + - [protos](#protos) +- [Cookie](#Cookie) + - [str](#str) +- [DownloaderParams](#DownloaderParams) +- [FetchConfig](#FetchConfig) +- [FileData](#FileData) +- [Header](#Header) + - [free](#free) + - [add](#add) + - [add_custom](#add_custom) + - [add_map](#add_map) + - [add_custom_map](#add_custom_map) + - [set](#set) + - [set_custom](#set_custom) + - [delete](#delete) + - [delete_custom](#delete_custom) + - [coerce](#coerce) + - [contains](#contains) + - [contains_custom](#contains_custom) + - [get](#get) + - [get_custom](#get_custom) + - [starting_with](#starting_with) + - [values](#values) + - [custom_values](#custom_values) + - [keys](#keys) + - [render](#render) + - [render_into_sb](#render_into_sb) + - [join](#join) + - [str](#str) +- [HeaderCoerceConfig](#HeaderCoerceConfig) +- [HeaderConfig](#HeaderConfig) +- [HeaderQueryConfig](#HeaderQueryConfig) +- [HeaderRenderConfig](#HeaderRenderConfig) +- [MultiplePathAttributesError](#MultiplePathAttributesError) + - [msg](#msg) +- [PostMultipartFormConfig](#PostMultipartFormConfig) +- [Request](#Request) + - [add_header](#add_header) + - [add_custom_header](#add_custom_header) + - [add_cookie](#add_cookie) + - [cookie](#cookie) + - [do](#do) + - [referer](#referer) +- [Response](#Response) + - [bytes](#bytes) + - [bytestr](#bytestr) + - [cookies](#cookies) + - [status](#status) + - [set_status](#set_status) + - [version](#version) + - [set_version](#set_version) +- [ResponseConfig](#ResponseConfig) +- [Server](#Server) + - [listen_and_serve](#listen_and_serve) + - [stop](#stop) + - [close](#close) + - [status](#status) + - [wait_till_running](#wait_till_running) +- [SilentStreamingDownloader](#SilentStreamingDownloader) + - [on_start](#on_start) + - [on_chunk](#on_chunk) + - [on_finish](#on_finish) +- [TerminalStreamingDownloader](#TerminalStreamingDownloader) + - [on_start](#on_start) + - [on_chunk](#on_chunk) + - [on_finish](#on_finish) +- [UnexpectedExtraAttributeError](#UnexpectedExtraAttributeError) + - [msg](#msg) +- [WaitTillRunningParams](#WaitTillRunningParams) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## download_file +[[Return to contents]](#Contents) + +## download_file_with_cookies +[[Return to contents]](#Contents) + +## download_file_with_progress +[[Return to contents]](#Contents) + +## fetch +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## get_text +[[Return to contents]](#Contents) + +## head +[[Return to contents]](#Contents) + +## is_cookie_domain_name +[[Return to contents]](#Contents) + +## method_from_str +[[Return to contents]](#Contents) + +## new_custom_header_from_map +[[Return to contents]](#Contents) + +## new_header +[[Return to contents]](#Contents) + +## new_header_from_map +[[Return to contents]](#Contents) + +## new_http_proxy +[[Return to contents]](#Contents) + +## new_request +[[Return to contents]](#Contents) + +## new_response +[[Return to contents]](#Contents) + +## parse_form +[[Return to contents]](#Contents) + +## parse_multipart_form +[[Return to contents]](#Contents) + +## parse_request +[[Return to contents]](#Contents) + +## parse_request_head +[[Return to contents]](#Contents) + +## parse_response +[[Return to contents]](#Contents) + +## patch +[[Return to contents]](#Contents) + +## post +[[Return to contents]](#Contents) + +## post_form +[[Return to contents]](#Contents) + +## post_form_with_cookies +[[Return to contents]](#Contents) + +## post_json +[[Return to contents]](#Contents) + +## post_multipart_form +[[Return to contents]](#Contents) + +## prepare +[[Return to contents]](#Contents) + +## put +[[Return to contents]](#Contents) + +## read_cookies +[[Return to contents]](#Contents) + +## sanitize_cookie_value +[[Return to contents]](#Contents) + +## status_from_int +[[Return to contents]](#Contents) + +## url_encode_form_data +[[Return to contents]](#Contents) + +## version_from_str +[[Return to contents]](#Contents) + +## Downloader +[[Return to contents]](#Contents) + +## Handler +[[Return to contents]](#Contents) + +## HeaderKeyError +## msg +[[Return to contents]](#Contents) + +## code +[[Return to contents]](#Contents) + +## RequestFinishFn +[[Return to contents]](#Contents) + +## RequestProgressBodyFn +[[Return to contents]](#Contents) + +## RequestProgressFn +[[Return to contents]](#Contents) + +## RequestRedirectFn +[[Return to contents]](#Contents) + +## CommonHeader +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Method +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## SameSite +[[Return to contents]](#Contents) + +## ServerStatus +[[Return to contents]](#Contents) + +## Status +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## is_valid +[[Return to contents]](#Contents) + +## is_error +[[Return to contents]](#Contents) + +## is_success +[[Return to contents]](#Contents) + +## Version +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## protos +[[Return to contents]](#Contents) + +## Cookie +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## DownloaderParams +[[Return to contents]](#Contents) + +## FetchConfig +[[Return to contents]](#Contents) + +## FileData +[[Return to contents]](#Contents) + +## Header +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add_custom +[[Return to contents]](#Contents) + +## add_map +[[Return to contents]](#Contents) + +## add_custom_map +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## set_custom +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## delete_custom +[[Return to contents]](#Contents) + +## coerce +[[Return to contents]](#Contents) + +## contains +[[Return to contents]](#Contents) + +## contains_custom +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## get_custom +[[Return to contents]](#Contents) + +## starting_with +[[Return to contents]](#Contents) + +## values +[[Return to contents]](#Contents) + +## custom_values +[[Return to contents]](#Contents) + +## keys +[[Return to contents]](#Contents) + +## render +[[Return to contents]](#Contents) + +## render_into_sb +[[Return to contents]](#Contents) + +## join +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## HeaderCoerceConfig +[[Return to contents]](#Contents) + +## HeaderConfig +[[Return to contents]](#Contents) + +## HeaderQueryConfig +[[Return to contents]](#Contents) + +## HeaderRenderConfig +[[Return to contents]](#Contents) + +## MultiplePathAttributesError +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## PostMultipartFormConfig +[[Return to contents]](#Contents) + +## Request +[[Return to contents]](#Contents) + +## add_header +[[Return to contents]](#Contents) + +## add_custom_header +[[Return to contents]](#Contents) + +## add_cookie +[[Return to contents]](#Contents) + +## cookie +[[Return to contents]](#Contents) + +## do +[[Return to contents]](#Contents) + +## referer +[[Return to contents]](#Contents) + +## Response +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## bytestr +[[Return to contents]](#Contents) + +## cookies +[[Return to contents]](#Contents) + +## status +[[Return to contents]](#Contents) + +## set_status +[[Return to contents]](#Contents) + +## version +[[Return to contents]](#Contents) + +## set_version +[[Return to contents]](#Contents) + +## ResponseConfig +[[Return to contents]](#Contents) + +## Server +[[Return to contents]](#Contents) + +## listen_and_serve +[[Return to contents]](#Contents) + +## stop +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## status +[[Return to contents]](#Contents) + +## wait_till_running +[[Return to contents]](#Contents) + +## SilentStreamingDownloader +[[Return to contents]](#Contents) + +## on_start +[[Return to contents]](#Contents) + +## on_chunk +[[Return to contents]](#Contents) + +## on_finish +[[Return to contents]](#Contents) + +## TerminalStreamingDownloader +[[Return to contents]](#Contents) + +## on_start +[[Return to contents]](#Contents) + +## on_chunk +[[Return to contents]](#Contents) + +## on_finish +[[Return to contents]](#Contents) + +## UnexpectedExtraAttributeError +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## WaitTillRunningParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.http.mime.md b/vdocs/net.http.mime.md new file mode 100644 index 00000000..6935e56d --- /dev/null +++ b/vdocs/net.http.mime.md @@ -0,0 +1,30 @@ +# module net.http.mime + + +## Contents +- [exists](#exists) +- [get_complete_mime_type](#get_complete_mime_type) +- [get_content_type](#get_content_type) +- [get_default_ext](#get_default_ext) +- [get_mime_type](#get_mime_type) +- [MimeType](#MimeType) + +## exists +[[Return to contents]](#Contents) + +## get_complete_mime_type +[[Return to contents]](#Contents) + +## get_content_type +[[Return to contents]](#Contents) + +## get_default_ext +[[Return to contents]](#Contents) + +## get_mime_type +[[Return to contents]](#Contents) + +## MimeType +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.mbedtls.md b/vdocs/net.mbedtls.md new file mode 100644 index 00000000..dacde4a7 --- /dev/null +++ b/vdocs/net.mbedtls.md @@ -0,0 +1,142 @@ +# module net.mbedtls + + +## Contents +- [new_ssl_conn](#new_ssl_conn) +- [new_ssl_listener](#new_ssl_listener) +- [new_sslcerts](#new_sslcerts) +- [new_sslcerts_from_file](#new_sslcerts_from_file) +- [new_sslcerts_in_memory](#new_sslcerts_in_memory) +- [C.mbedtls_ctr_drbg_context](#C.mbedtls_ctr_drbg_context) +- [C.mbedtls_entropy_context](#C.mbedtls_entropy_context) +- [C.mbedtls_net_context](#C.mbedtls_net_context) +- [C.mbedtls_pk_context](#C.mbedtls_pk_context) +- [C.mbedtls_ssl_config](#C.mbedtls_ssl_config) +- [C.mbedtls_ssl_context](#C.mbedtls_ssl_context) +- [C.mbedtls_ssl_recv_t](#C.mbedtls_ssl_recv_t) +- [C.mbedtls_ssl_recv_timeout_t](#C.mbedtls_ssl_recv_timeout_t) +- [C.mbedtls_ssl_send_t](#C.mbedtls_ssl_send_t) +- [C.mbedtls_x509_crl](#C.mbedtls_x509_crl) +- [C.mbedtls_x509_crt](#C.mbedtls_x509_crt) +- [SSLCerts](#SSLCerts) + - [cleanup](#cleanup) +- [SSLConn](#SSLConn) + - [close](#close) + - [shutdown](#shutdown) + - [connect](#connect) + - [dial](#dial) + - [addr](#addr) + - [peer_addr](#peer_addr) + - [socket_read_into_ptr](#socket_read_into_ptr) + - [read](#read) + - [write_ptr](#write_ptr) + - [write](#write) + - [write_string](#write_string) +- [SSLConnectConfig](#SSLConnectConfig) +- [SSLListener](#SSLListener) + - [shutdown](#shutdown) + - [accept](#accept) + +## new_ssl_conn +[[Return to contents]](#Contents) + +## new_ssl_listener +[[Return to contents]](#Contents) + +## new_sslcerts +[[Return to contents]](#Contents) + +## new_sslcerts_from_file +[[Return to contents]](#Contents) + +## new_sslcerts_in_memory +[[Return to contents]](#Contents) + +## C.mbedtls_ctr_drbg_context +[[Return to contents]](#Contents) + +## C.mbedtls_entropy_context +[[Return to contents]](#Contents) + +## C.mbedtls_net_context +[[Return to contents]](#Contents) + +## C.mbedtls_pk_context +[[Return to contents]](#Contents) + +## C.mbedtls_ssl_config +[[Return to contents]](#Contents) + +## C.mbedtls_ssl_context +[[Return to contents]](#Contents) + +## C.mbedtls_ssl_recv_t +[[Return to contents]](#Contents) + +## C.mbedtls_ssl_recv_timeout_t +[[Return to contents]](#Contents) + +## C.mbedtls_ssl_send_t +[[Return to contents]](#Contents) + +## C.mbedtls_x509_crl +[[Return to contents]](#Contents) + +## C.mbedtls_x509_crt +[[Return to contents]](#Contents) + +## SSLCerts +[[Return to contents]](#Contents) + +## cleanup +[[Return to contents]](#Contents) + +## SSLConn +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## connect +[[Return to contents]](#Contents) + +## dial +[[Return to contents]](#Contents) + +## addr +[[Return to contents]](#Contents) + +## peer_addr +[[Return to contents]](#Contents) + +## socket_read_into_ptr +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## SSLConnectConfig +[[Return to contents]](#Contents) + +## SSLListener +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## accept +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.md b/vdocs/net.md new file mode 100644 index 00000000..06973f81 --- /dev/null +++ b/vdocs/net.md @@ -0,0 +1,512 @@ +# module net + + +## Contents +- [Constants](#Constants) +- [addr_from_socket_handle](#addr_from_socket_handle) +- [close](#close) +- [default_tcp_dialer](#default_tcp_dialer) +- [dial_tcp](#dial_tcp) +- [dial_tcp_with_bind](#dial_tcp_with_bind) +- [dial_udp](#dial_udp) +- [error_code](#error_code) +- [listen_tcp](#listen_tcp) +- [listen_udp](#listen_udp) +- [new_ip](#new_ip) +- [new_ip6](#new_ip6) +- [new_tcp_socket](#new_tcp_socket) +- [peer_addr_from_socket_handle](#peer_addr_from_socket_handle) +- [resolve_addrs](#resolve_addrs) +- [resolve_addrs_fuzzy](#resolve_addrs_fuzzy) +- [resolve_ipaddrs](#resolve_ipaddrs) +- [set_blocking](#set_blocking) +- [shutdown](#shutdown) +- [socket_error](#socket_error) +- [socket_error_message](#socket_error_message) +- [split_address](#split_address) +- [tcp_socket_from_handle_raw](#tcp_socket_from_handle_raw) +- [validate_port](#validate_port) +- [wrap_error](#wrap_error) +- [Connection](#Connection) +- [Dialer](#Dialer) +- [TcpSocket](#TcpSocket) + - [set_option_bool](#set_option_bool) + - [set_option_int](#set_option_int) + - [set_dualstack](#set_dualstack) + - [bind](#bind) +- [UdpSocket](#UdpSocket) + - [set_option_bool](#set_option_bool) + - [set_dualstack](#set_dualstack) +- [AddrFamily](#AddrFamily) +- [ShutdownDirection](#ShutdownDirection) +- [SocketOption](#SocketOption) +- [SocketType](#SocketType) +- [Addr](#Addr) + - [family](#family) + - [len](#len) + - [port](#port) + - [str](#str) +- [C.addrinfo](#C.addrinfo) +- [C.fd_set](#C.fd_set) +- [C.sockaddr_in](#C.sockaddr_in) +- [C.sockaddr_in6](#C.sockaddr_in6) +- [C.sockaddr_un](#C.sockaddr_un) +- [Ip](#Ip) + - [str](#str) +- [Ip6](#Ip6) + - [str](#str) +- [ListenOptions](#ListenOptions) +- [ShutdownConfig](#ShutdownConfig) +- [Socket](#Socket) + - [address](#address) +- [TCPDialer](#TCPDialer) + - [dial](#dial) +- [TcpConn](#TcpConn) + - [addr](#addr) + - [close](#close) + - [get_blocking](#get_blocking) + - [peer_addr](#peer_addr) + - [peer_ip](#peer_ip) + - [read](#read) + - [read_deadline](#read_deadline) + - [read_line](#read_line) + - [read_line_max](#read_line_max) + - [read_ptr](#read_ptr) + - [read_timeout](#read_timeout) + - [set_blocking](#set_blocking) + - [set_read_deadline](#set_read_deadline) + - [set_read_timeout](#set_read_timeout) + - [set_sock](#set_sock) + - [set_write_deadline](#set_write_deadline) + - [set_write_timeout](#set_write_timeout) + - [str](#str) + - [wait_for_read](#wait_for_read) + - [wait_for_write](#wait_for_write) + - [write](#write) + - [write_deadline](#write_deadline) + - [write_ptr](#write_ptr) + - [write_string](#write_string) + - [write_timeout](#write_timeout) +- [TcpListener](#TcpListener) + - [accept](#accept) + - [accept_only](#accept_only) + - [accept_deadline](#accept_deadline) + - [set_accept_deadline](#set_accept_deadline) + - [accept_timeout](#accept_timeout) + - [set_accept_timeout](#set_accept_timeout) + - [wait_for_accept](#wait_for_accept) + - [close](#close) + - [addr](#addr) +- [UdpConn](#UdpConn) + - [write_ptr](#write_ptr) + - [write](#write) + - [write_string](#write_string) + - [write_to_ptr](#write_to_ptr) + - [write_to](#write_to) + - [write_to_string](#write_to_string) + - [read](#read) + - [read_deadline](#read_deadline) + - [set_read_deadline](#set_read_deadline) + - [write_deadline](#write_deadline) + - [set_write_deadline](#set_write_deadline) + - [read_timeout](#read_timeout) + - [set_read_timeout](#set_read_timeout) + - [write_timeout](#write_timeout) + - [set_write_timeout](#set_write_timeout) + - [wait_for_read](#wait_for_read) + - [wait_for_write](#wait_for_write) + - [str](#str) + - [close](#close) +- [Unix](#Unix) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## addr_from_socket_handle +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## default_tcp_dialer +[[Return to contents]](#Contents) + +## dial_tcp +[[Return to contents]](#Contents) + +## dial_tcp_with_bind +[[Return to contents]](#Contents) + +## dial_udp +[[Return to contents]](#Contents) + +## error_code +[[Return to contents]](#Contents) + +## listen_tcp +[[Return to contents]](#Contents) + +## listen_udp +[[Return to contents]](#Contents) + +## new_ip +[[Return to contents]](#Contents) + +## new_ip6 +[[Return to contents]](#Contents) + +## new_tcp_socket +[[Return to contents]](#Contents) + +## peer_addr_from_socket_handle +[[Return to contents]](#Contents) + +## resolve_addrs +[[Return to contents]](#Contents) + +## resolve_addrs_fuzzy +[[Return to contents]](#Contents) + +## resolve_ipaddrs +[[Return to contents]](#Contents) + +## set_blocking +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## socket_error +[[Return to contents]](#Contents) + +## socket_error_message +[[Return to contents]](#Contents) + +## split_address +[[Return to contents]](#Contents) + +## tcp_socket_from_handle_raw +[[Return to contents]](#Contents) + +## validate_port +[[Return to contents]](#Contents) + +## wrap_error +[[Return to contents]](#Contents) + +## Connection +[[Return to contents]](#Contents) + +## Dialer +[[Return to contents]](#Contents) + +## TcpSocket +## set_option_bool +[[Return to contents]](#Contents) + +## set_option_int +[[Return to contents]](#Contents) + +## set_dualstack +[[Return to contents]](#Contents) + +## bind +[[Return to contents]](#Contents) + +## UdpSocket +## set_option_bool +[[Return to contents]](#Contents) + +## set_dualstack +[[Return to contents]](#Contents) + +## AddrFamily +[[Return to contents]](#Contents) + +## ShutdownDirection +[[Return to contents]](#Contents) + +## SocketOption +[[Return to contents]](#Contents) + +## SocketType +[[Return to contents]](#Contents) + +## Addr +[[Return to contents]](#Contents) + +## family +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## port +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## C.addrinfo +[[Return to contents]](#Contents) + +## C.fd_set +[[Return to contents]](#Contents) + +## C.sockaddr_in +[[Return to contents]](#Contents) + +## C.sockaddr_in6 +[[Return to contents]](#Contents) + +## C.sockaddr_un +[[Return to contents]](#Contents) + +## Ip +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Ip6 +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ListenOptions +[[Return to contents]](#Contents) + +## ShutdownConfig +[[Return to contents]](#Contents) + +## Socket +[[Return to contents]](#Contents) + +## address +[[Return to contents]](#Contents) + +## TCPDialer +[[Return to contents]](#Contents) + +## dial +[[Return to contents]](#Contents) + +## TcpConn +[[Return to contents]](#Contents) + +## addr +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## get_blocking +[[Return to contents]](#Contents) + +## peer_addr +[[Return to contents]](#Contents) + +## peer_ip +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## read_deadline +[[Return to contents]](#Contents) + +## read_line +[[Return to contents]](#Contents) + +## read_line_max +[[Return to contents]](#Contents) + +## read_ptr +[[Return to contents]](#Contents) + +## read_timeout +[[Return to contents]](#Contents) + +## set_blocking +[[Return to contents]](#Contents) + +## set_read_deadline +[[Return to contents]](#Contents) + +## set_read_timeout +[[Return to contents]](#Contents) + +## set_sock +[[Return to contents]](#Contents) + +## set_write_deadline +[[Return to contents]](#Contents) + +## set_write_timeout +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## wait_for_read +[[Return to contents]](#Contents) + +## wait_for_write +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## write_deadline +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## write_timeout +[[Return to contents]](#Contents) + +## TcpListener +[[Return to contents]](#Contents) + +## accept +[[Return to contents]](#Contents) + +## accept_only +[[Return to contents]](#Contents) + +## accept_deadline +[[Return to contents]](#Contents) + +## set_accept_deadline +[[Return to contents]](#Contents) + +## accept_timeout +[[Return to contents]](#Contents) + +## set_accept_timeout +[[Return to contents]](#Contents) + +## wait_for_accept +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## addr +[[Return to contents]](#Contents) + +## UdpConn +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## write_to_ptr +[[Return to contents]](#Contents) + +## write_to +[[Return to contents]](#Contents) + +## write_to_string +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## read_deadline +[[Return to contents]](#Contents) + +## set_read_deadline +[[Return to contents]](#Contents) + +## write_deadline +[[Return to contents]](#Contents) + +## set_write_deadline +[[Return to contents]](#Contents) + +## read_timeout +[[Return to contents]](#Contents) + +## set_read_timeout +[[Return to contents]](#Contents) + +## write_timeout +[[Return to contents]](#Contents) + +## set_write_timeout +[[Return to contents]](#Contents) + +## wait_for_read +[[Return to contents]](#Contents) + +## wait_for_write +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## Unix +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.openssl.md b/vdocs/net.openssl.md new file mode 100644 index 00000000..cda7ba45 --- /dev/null +++ b/vdocs/net.openssl.md @@ -0,0 +1,82 @@ +# module net.openssl + + +## Contents +- [new_ssl_conn](#new_ssl_conn) +- [C.BIO](#C.BIO) +- [C.SSL](#C.SSL) +- [C.SSL_CTX](#C.SSL_CTX) +- [C.SSL_METHOD](#C.SSL_METHOD) +- [C.X509](#C.X509) +- [SSLConn](#SSLConn) + - [close](#close) + - [shutdown](#shutdown) + - [connect](#connect) + - [dial](#dial) + - [addr](#addr) + - [peer_addr](#peer_addr) + - [socket_read_into_ptr](#socket_read_into_ptr) + - [read](#read) + - [write_ptr](#write_ptr) + - [write](#write) + - [write_string](#write_string) +- [SSLConnectConfig](#SSLConnectConfig) + +## new_ssl_conn +[[Return to contents]](#Contents) + +## C.BIO +[[Return to contents]](#Contents) + +## C.SSL +[[Return to contents]](#Contents) + +## C.SSL_CTX +[[Return to contents]](#Contents) + +## C.SSL_METHOD +[[Return to contents]](#Contents) + +## C.X509 +[[Return to contents]](#Contents) + +## SSLConn +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## connect +[[Return to contents]](#Contents) + +## dial +[[Return to contents]](#Contents) + +## addr +[[Return to contents]](#Contents) + +## peer_addr +[[Return to contents]](#Contents) + +## socket_read_into_ptr +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## SSLConnectConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.smtp.md b/vdocs/net.smtp.md new file mode 100644 index 00000000..21659922 --- /dev/null +++ b/vdocs/net.smtp.md @@ -0,0 +1,38 @@ +# module net.smtp + + +## Contents +- [new_client](#new_client) +- [BodyType](#BodyType) +- [Attachment](#Attachment) +- [Client](#Client) + - [reconnect](#reconnect) + - [send](#send) + - [quit](#quit) +- [Mail](#Mail) + +## new_client +[[Return to contents]](#Contents) + +## BodyType +[[Return to contents]](#Contents) + +## Attachment +[[Return to contents]](#Contents) + +## Client +[[Return to contents]](#Contents) + +## reconnect +[[Return to contents]](#Contents) + +## send +[[Return to contents]](#Contents) + +## quit +[[Return to contents]](#Contents) + +## Mail +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.socks.md b/vdocs/net.socks.md new file mode 100644 index 00000000..d7e49387 --- /dev/null +++ b/vdocs/net.socks.md @@ -0,0 +1,26 @@ +# module net.socks + + +## Contents +- [new_socks5_dialer](#new_socks5_dialer) +- [socks5_dial](#socks5_dial) +- [socks5_ssl_dial](#socks5_ssl_dial) +- [SOCKS5Dialer](#SOCKS5Dialer) + - [dial](#dial) + +## new_socks5_dialer +[[Return to contents]](#Contents) + +## socks5_dial +[[Return to contents]](#Contents) + +## socks5_ssl_dial +[[Return to contents]](#Contents) + +## SOCKS5Dialer +[[Return to contents]](#Contents) + +## dial +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.ssl.md b/vdocs/net.ssl.md new file mode 100644 index 00000000..cae0dee0 --- /dev/null +++ b/vdocs/net.ssl.md @@ -0,0 +1,30 @@ +# module net.ssl + + +## Contents +- [new_ssl_conn](#new_ssl_conn) +- [new_ssl_dialer](#new_ssl_dialer) +- [SSLConn](#SSLConn) +- [SSLConnectConfig](#SSLConnectConfig) +- [SSLDialer](#SSLDialer) + - [dial](#dial) + +## new_ssl_conn +[[Return to contents]](#Contents) + +## new_ssl_dialer +[[Return to contents]](#Contents) + +## SSLConn +[[Return to contents]](#Contents) + +## SSLConnectConfig +[[Return to contents]](#Contents) + +## SSLDialer +[[Return to contents]](#Contents) + +## dial +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.unix.md b/vdocs/net.unix.md new file mode 100644 index 00000000..1f16b830 --- /dev/null +++ b/vdocs/net.unix.md @@ -0,0 +1,174 @@ +# module net.unix + + +## Contents +- [close](#close) +- [connect_stream](#connect_stream) +- [listen_stream](#listen_stream) +- [shutdown](#shutdown) +- [stream_socket_from_handle](#stream_socket_from_handle) +- [ListenOptions](#ListenOptions) +- [StreamConn](#StreamConn) + - [addr](#addr) + - [peer_addr](#peer_addr) + - [close](#close) + - [write_ptr](#write_ptr) + - [write](#write) + - [write_string](#write_string) + - [read_ptr](#read_ptr) + - [read](#read) + - [read_deadline](#read_deadline) + - [set_read_deadline](#set_read_deadline) + - [write_deadline](#write_deadline) + - [set_write_deadline](#set_write_deadline) + - [read_timeout](#read_timeout) + - [set_read_timeout](#set_read_timeout) + - [write_timeout](#write_timeout) + - [set_write_timeout](#set_write_timeout) + - [wait_for_read](#wait_for_read) + - [wait_for_write](#wait_for_write) + - [str](#str) +- [StreamListener](#StreamListener) + - [accept](#accept) + - [accept_deadline](#accept_deadline) + - [set_accept_deadline](#set_accept_deadline) + - [accept_timeout](#accept_timeout) + - [set_accept_timeout](#set_accept_timeout) + - [wait_for_accept](#wait_for_accept) + - [close](#close) + - [unlink](#unlink) + - [unlink_on_signal](#unlink_on_signal) + - [addr](#addr) +- [StreamSocket](#StreamSocket) + - [set_option_bool](#set_option_bool) + - [set_option_int](#set_option_int) +- [UnixDialer](#UnixDialer) + - [dial](#dial) + +## close +[[Return to contents]](#Contents) + +## connect_stream +[[Return to contents]](#Contents) + +## listen_stream +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## stream_socket_from_handle +[[Return to contents]](#Contents) + +## ListenOptions +[[Return to contents]](#Contents) + +## StreamConn +[[Return to contents]](#Contents) + +## addr +[[Return to contents]](#Contents) + +## peer_addr +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## read_ptr +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## read_deadline +[[Return to contents]](#Contents) + +## set_read_deadline +[[Return to contents]](#Contents) + +## write_deadline +[[Return to contents]](#Contents) + +## set_write_deadline +[[Return to contents]](#Contents) + +## read_timeout +[[Return to contents]](#Contents) + +## set_read_timeout +[[Return to contents]](#Contents) + +## write_timeout +[[Return to contents]](#Contents) + +## set_write_timeout +[[Return to contents]](#Contents) + +## wait_for_read +[[Return to contents]](#Contents) + +## wait_for_write +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## StreamListener +[[Return to contents]](#Contents) + +## accept +[[Return to contents]](#Contents) + +## accept_deadline +[[Return to contents]](#Contents) + +## set_accept_deadline +[[Return to contents]](#Contents) + +## accept_timeout +[[Return to contents]](#Contents) + +## set_accept_timeout +[[Return to contents]](#Contents) + +## wait_for_accept +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## unlink +[[Return to contents]](#Contents) + +## unlink_on_signal +[[Return to contents]](#Contents) + +## addr +[[Return to contents]](#Contents) + +## StreamSocket +[[Return to contents]](#Contents) + +## set_option_bool +[[Return to contents]](#Contents) + +## set_option_int +[[Return to contents]](#Contents) + +## UnixDialer +[[Return to contents]](#Contents) + +## dial +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.urllib.md b/vdocs/net.urllib.md new file mode 100644 index 00000000..3e8f6961 --- /dev/null +++ b/vdocs/net.urllib.md @@ -0,0 +1,134 @@ +# module net.urllib + + +## Contents +- [ishex](#ishex) +- [new_values](#new_values) +- [parse](#parse) +- [parse_query](#parse_query) +- [path_escape](#path_escape) +- [path_unescape](#path_unescape) +- [query_escape](#query_escape) +- [query_unescape](#query_unescape) +- [split_host_port](#split_host_port) +- [user](#user) +- [valid_userinfo](#valid_userinfo) +- [URL](#URL) + - [debug](#debug) + - [set_path](#set_path) + - [escaped_path](#escaped_path) + - [str](#str) + - [is_abs](#is_abs) + - [parse](#parse) + - [resolve_reference](#resolve_reference) + - [query](#query) + - [request_uri](#request_uri) + - [hostname](#hostname) + - [port](#port) +- [Values](#Values) + - [add](#add) + - [del](#del) + - [encode](#encode) + - [get](#get) + - [get_all](#get_all) + - [set](#set) + - [to_map](#to_map) + - [values](#values) + +## ishex +[[Return to contents]](#Contents) + +## new_values +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## parse_query +[[Return to contents]](#Contents) + +## path_escape +[[Return to contents]](#Contents) + +## path_unescape +[[Return to contents]](#Contents) + +## query_escape +[[Return to contents]](#Contents) + +## query_unescape +[[Return to contents]](#Contents) + +## split_host_port +[[Return to contents]](#Contents) + +## user +[[Return to contents]](#Contents) + +## valid_userinfo +[[Return to contents]](#Contents) + +## URL +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## set_path +[[Return to contents]](#Contents) + +## escaped_path +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## is_abs +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## resolve_reference +[[Return to contents]](#Contents) + +## query +[[Return to contents]](#Contents) + +## request_uri +[[Return to contents]](#Contents) + +## hostname +[[Return to contents]](#Contents) + +## port +[[Return to contents]](#Contents) + +## Values +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## del +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## get_all +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## to_map +[[Return to contents]](#Contents) + +## values +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/net.websocket.md b/vdocs/net.websocket.md new file mode 100644 index 00000000..f67afffc --- /dev/null +++ b/vdocs/net.websocket.md @@ -0,0 +1,240 @@ +# module net.websocket + + +## Contents +- [new_client](#new_client) +- [new_server](#new_server) +- [AcceptClientFn](#AcceptClientFn) +- [SocketCloseFn](#SocketCloseFn) +- [SocketCloseFn2](#SocketCloseFn2) +- [SocketErrorFn](#SocketErrorFn) +- [SocketErrorFn2](#SocketErrorFn2) +- [SocketMessageFn](#SocketMessageFn) +- [SocketMessageFn2](#SocketMessageFn2) +- [SocketOpenFn](#SocketOpenFn) +- [SocketOpenFn2](#SocketOpenFn2) +- [Uri](#Uri) + - [str](#str) +- [OPCode](#OPCode) +- [State](#State) +- [Client](#Client) + - [close](#close) + - [connect](#connect) + - [free](#free) + - [get_state](#get_state) + - [listen](#listen) + - [on_close](#on_close) + - [on_close_ref](#on_close_ref) + - [on_error](#on_error) + - [on_error_ref](#on_error_ref) + - [on_message](#on_message) + - [on_message_ref](#on_message_ref) + - [on_open](#on_open) + - [on_open_ref](#on_open_ref) + - [parse_frame_header](#parse_frame_header) + - [ping](#ping) + - [pong](#pong) + - [read_next_message](#read_next_message) + - [reset_state](#reset_state) + - [set_state](#set_state) + - [validate_frame](#validate_frame) + - [write](#write) + - [write_ptr](#write_ptr) + - [write_string](#write_string) +- [ClientOpt](#ClientOpt) +- [ClientState](#ClientState) +- [Message](#Message) + - [free](#free) +- [Server](#Server) + - [free](#free) + - [get_ping_interval](#get_ping_interval) + - [get_state](#get_state) + - [handle_handshake](#handle_handshake) + - [listen](#listen) + - [on_close](#on_close) + - [on_close_ref](#on_close_ref) + - [on_connect](#on_connect) + - [on_message](#on_message) + - [on_message_ref](#on_message_ref) + - [set_ping_interval](#set_ping_interval) + - [set_state](#set_state) +- [ServerClient](#ServerClient) +- [ServerOpt](#ServerOpt) +- [ServerState](#ServerState) + +## new_client +[[Return to contents]](#Contents) + +## new_server +[[Return to contents]](#Contents) + +## AcceptClientFn +[[Return to contents]](#Contents) + +## SocketCloseFn +[[Return to contents]](#Contents) + +## SocketCloseFn2 +[[Return to contents]](#Contents) + +## SocketErrorFn +[[Return to contents]](#Contents) + +## SocketErrorFn2 +[[Return to contents]](#Contents) + +## SocketMessageFn +[[Return to contents]](#Contents) + +## SocketMessageFn2 +[[Return to contents]](#Contents) + +## SocketOpenFn +[[Return to contents]](#Contents) + +## SocketOpenFn2 +[[Return to contents]](#Contents) + +## Uri +## str +[[Return to contents]](#Contents) + +## OPCode +[[Return to contents]](#Contents) + +## State +[[Return to contents]](#Contents) + +## Client +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## connect +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## get_state +[[Return to contents]](#Contents) + +## listen +[[Return to contents]](#Contents) + +## on_close +[[Return to contents]](#Contents) + +## on_close_ref +[[Return to contents]](#Contents) + +## on_error +[[Return to contents]](#Contents) + +## on_error_ref +[[Return to contents]](#Contents) + +## on_message +[[Return to contents]](#Contents) + +## on_message_ref +[[Return to contents]](#Contents) + +## on_open +[[Return to contents]](#Contents) + +## on_open_ref +[[Return to contents]](#Contents) + +## parse_frame_header +[[Return to contents]](#Contents) + +## ping +[[Return to contents]](#Contents) + +## pong +[[Return to contents]](#Contents) + +## read_next_message +[[Return to contents]](#Contents) + +## reset_state +[[Return to contents]](#Contents) + +## set_state +[[Return to contents]](#Contents) + +## validate_frame +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## ClientOpt +[[Return to contents]](#Contents) + +## ClientState +[[Return to contents]](#Contents) + +## Message +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## Server +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## get_ping_interval +[[Return to contents]](#Contents) + +## get_state +[[Return to contents]](#Contents) + +## handle_handshake +[[Return to contents]](#Contents) + +## listen +[[Return to contents]](#Contents) + +## on_close +[[Return to contents]](#Contents) + +## on_close_ref +[[Return to contents]](#Contents) + +## on_connect +[[Return to contents]](#Contents) + +## on_message +[[Return to contents]](#Contents) + +## on_message_ref +[[Return to contents]](#Contents) + +## set_ping_interval +[[Return to contents]](#Contents) + +## set_state +[[Return to contents]](#Contents) + +## ServerClient +[[Return to contents]](#Contents) + +## ServerOpt +[[Return to contents]](#Contents) + +## ServerState +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/orm.md b/vdocs/orm.md new file mode 100644 index 00000000..09c04b1b --- /dev/null +++ b/vdocs/orm.md @@ -0,0 +1,88 @@ +# module orm + + +## Contents +- [Constants](#Constants) +- [orm_select_gen](#orm_select_gen) +- [orm_stmt_gen](#orm_stmt_gen) +- [orm_table_gen](#orm_table_gen) +- [Connection](#Connection) +- [Primitive](#Primitive) +- [MathOperationKind](#MathOperationKind) +- [OperationKind](#OperationKind) +- [OrderType](#OrderType) +- [SQLDialect](#SQLDialect) +- [StmtKind](#StmtKind) +- [InfixType](#InfixType) +- [Null](#Null) +- [QueryData](#QueryData) +- [SelectConfig](#SelectConfig) +- [TableField](#TableField) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## orm_select_gen +[[Return to contents]](#Contents) + +## orm_stmt_gen +[[Return to contents]](#Contents) + +## orm_table_gen +[[Return to contents]](#Contents) + +## Connection +[[Return to contents]](#Contents) + +## Primitive +[[Return to contents]](#Contents) + +## MathOperationKind +[[Return to contents]](#Contents) + +## OperationKind +[[Return to contents]](#Contents) + +## OrderType +[[Return to contents]](#Contents) + +## SQLDialect +[[Return to contents]](#Contents) + +## StmtKind +[[Return to contents]](#Contents) + +## InfixType +[[Return to contents]](#Contents) + +## Null +[[Return to contents]](#Contents) + +## QueryData +[[Return to contents]](#Contents) + +## SelectConfig +[[Return to contents]](#Contents) + +## TableField +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/os.asset.md b/vdocs/os.asset.md new file mode 100644 index 00000000..a2fdcc72 --- /dev/null +++ b/vdocs/os.asset.md @@ -0,0 +1,14 @@ +# module os.asset + + +## Contents +- [get_path](#get_path) +- [read_bytes](#read_bytes) + +## get_path +[[Return to contents]](#Contents) + +## read_bytes +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/os.cmdline.md b/vdocs/os.cmdline.md new file mode 100644 index 00000000..499f92da --- /dev/null +++ b/vdocs/os.cmdline.md @@ -0,0 +1,30 @@ +# module os.cmdline + + +## Contents +- [only_non_options](#only_non_options) +- [only_options](#only_options) +- [option](#option) +- [options](#options) +- [options_after](#options_after) +- [options_before](#options_before) + +## only_non_options +[[Return to contents]](#Contents) + +## only_options +[[Return to contents]](#Contents) + +## option +[[Return to contents]](#Contents) + +## options +[[Return to contents]](#Contents) + +## options_after +[[Return to contents]](#Contents) + +## options_before +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/os.filelock.md b/vdocs/os.filelock.md new file mode 100644 index 00000000..4b0cbae8 --- /dev/null +++ b/vdocs/os.filelock.md @@ -0,0 +1,34 @@ +# module os.filelock + + +## Contents +- [new](#new) +- [FileLock](#FileLock) + - [acquire](#acquire) + - [release](#release) + - [try_acquire](#try_acquire) + - [unlink](#unlink) + - [wait_acquire](#wait_acquire) + +## new +[[Return to contents]](#Contents) + +## FileLock +[[Return to contents]](#Contents) + +## acquire +[[Return to contents]](#Contents) + +## release +[[Return to contents]](#Contents) + +## try_acquire +[[Return to contents]](#Contents) + +## unlink +[[Return to contents]](#Contents) + +## wait_acquire +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/os.font.md b/vdocs/os.font.md new file mode 100644 index 00000000..101ae5f8 --- /dev/null +++ b/vdocs/os.font.md @@ -0,0 +1,18 @@ +# module os.font + + +## Contents +- [default](#default) +- [get_path_variant](#get_path_variant) +- [Variant](#Variant) + +## default +[[Return to contents]](#Contents) + +## get_path_variant +[[Return to contents]](#Contents) + +## Variant +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/os.md b/vdocs/os.md new file mode 100644 index 00000000..ae33bbc8 --- /dev/null +++ b/vdocs/os.md @@ -0,0 +1,1075 @@ +# module os + + +## Contents +- [Constants](#Constants) +- [abs_path](#abs_path) +- [args_after](#args_after) +- [args_before](#args_before) +- [base](#base) +- [cache_dir](#cache_dir) +- [chdir](#chdir) +- [chmod](#chmod) +- [chown](#chown) +- [config_dir](#config_dir) +- [cp](#cp) +- [cp_all](#cp_all) +- [create](#create) +- [data_dir](#data_dir) +- [debugger_present](#debugger_present) +- [dir](#dir) +- [disk_usage](#disk_usage) +- [ensure_folder_is_writable](#ensure_folder_is_writable) +- [environ](#environ) +- [error_posix](#error_posix) +- [error_win32](#error_win32) +- [executable](#executable) +- [execute](#execute) +- [execute_opt](#execute_opt) +- [execute_or_exit](#execute_or_exit) +- [execute_or_panic](#execute_or_panic) +- [execve](#execve) +- [execvp](#execvp) +- [existing_path](#existing_path) +- [exists](#exists) +- [exists_in_system_path](#exists_in_system_path) +- [expand_tilde_to_home](#expand_tilde_to_home) +- [fd_close](#fd_close) +- [fd_is_pending](#fd_is_pending) +- [fd_read](#fd_read) +- [fd_slurp](#fd_slurp) +- [fd_write](#fd_write) +- [file_ext](#file_ext) +- [file_last_mod_unix](#file_last_mod_unix) +- [file_name](#file_name) +- [file_size](#file_size) +- [fileno](#fileno) +- [find_abs_path_of_executable](#find_abs_path_of_executable) +- [flush](#flush) +- [fork](#fork) +- [from_slash](#from_slash) +- [get_error_msg](#get_error_msg) +- [get_line](#get_line) +- [get_lines](#get_lines) +- [get_lines_joined](#get_lines_joined) +- [get_raw_line](#get_raw_line) +- [get_raw_lines](#get_raw_lines) +- [get_raw_lines_joined](#get_raw_lines_joined) +- [get_raw_stdin](#get_raw_stdin) +- [get_trimmed_lines](#get_trimmed_lines) +- [getegid](#getegid) +- [getenv](#getenv) +- [getenv_opt](#getenv_opt) +- [geteuid](#geteuid) +- [getgid](#getgid) +- [getpid](#getpid) +- [getppid](#getppid) +- [getuid](#getuid) +- [getwd](#getwd) +- [glob](#glob) +- [home_dir](#home_dir) +- [hostname](#hostname) +- [inode](#inode) +- [input](#input) +- [input_opt](#input_opt) +- [input_password](#input_password) +- [is_abs_path](#is_abs_path) +- [is_atty](#is_atty) +- [is_dir](#is_dir) +- [is_dir_empty](#is_dir_empty) +- [is_executable](#is_executable) +- [is_file](#is_file) +- [is_link](#is_link) +- [is_main_thread](#is_main_thread) +- [is_readable](#is_readable) +- [is_writable](#is_writable) +- [join_path](#join_path) +- [join_path_single](#join_path_single) +- [last_error](#last_error) +- [link](#link) +- [local_bin_dir](#local_bin_dir) +- [log](#log) +- [loginname](#loginname) +- [ls](#ls) +- [lstat](#lstat) +- [mkdir](#mkdir) +- [mkdir_all](#mkdir_all) +- [mv](#mv) +- [mv_by_cp](#mv_by_cp) +- [new_process](#new_process) +- [norm_path](#norm_path) +- [open](#open) +- [open_append](#open_append) +- [open_file](#open_file) +- [open_uri](#open_uri) +- [page_size](#page_size) +- [posix_get_error_msg](#posix_get_error_msg) +- [posix_set_permission_bit](#posix_set_permission_bit) +- [quoted_path](#quoted_path) +- [raw_execute](#raw_execute) +- [read_bytes](#read_bytes) +- [read_file](#read_file) +- [read_file_array](#read_file_array) +- [read_lines](#read_lines) +- [real_path](#real_path) +- [rename](#rename) +- [rename_dir](#rename_dir) +- [resource_abs_path](#resource_abs_path) +- [rm](#rm) +- [rmdir](#rmdir) +- [rmdir_all](#rmdir_all) +- [setenv](#setenv) +- [sigint_to_signal_name](#sigint_to_signal_name) +- [signal_ignore](#signal_ignore) +- [signal_opt](#signal_opt) +- [split_path](#split_path) +- [stat](#stat) +- [state_dir](#state_dir) +- [stderr](#stderr) +- [stdin](#stdin) +- [stdout](#stdout) +- [symlink](#symlink) +- [system](#system) +- [temp_dir](#temp_dir) +- [to_slash](#to_slash) +- [truncate](#truncate) +- [uname](#uname) +- [unsetenv](#unsetenv) +- [user_names](#user_names) +- [user_os](#user_os) +- [utime](#utime) +- [vfopen](#vfopen) +- [vmodules_dir](#vmodules_dir) +- [vmodules_paths](#vmodules_paths) +- [vtmp_dir](#vtmp_dir) +- [wait](#wait) +- [walk](#walk) +- [walk_ext](#walk_ext) +- [walk_with_context](#walk_with_context) +- [write_file](#write_file) +- [write_file_array](#write_file_array) +- [write_lines](#write_lines) +- [FN_SA_Handler](#FN_SA_Handler) +- [FnWalkContextCB](#FnWalkContextCB) +- [SignalHandler](#SignalHandler) +- [ChildProcessPipeKind](#ChildProcessPipeKind) +- [FileBufferMode](#FileBufferMode) +- [FileType](#FileType) +- [ProcessState](#ProcessState) +- [SeekMode](#SeekMode) +- [Signal](#Signal) +- [C.__stat64](#C.__stat64) +- [C.dirent](#C.dirent) +- [C.fd_set](#C.fd_set) +- [C.sigaction](#C.sigaction) +- [C.stat](#C.stat) +- [C.timespec](#C.timespec) +- [C.timeval](#C.timeval) +- [C.utimbuf](#C.utimbuf) +- [C.utsname](#C.utsname) +- [Command](#Command) + - [close](#close) + - [read_line](#read_line) + - [start](#start) +- [DiskUsage](#DiskUsage) +- [Eof](#Eof) +- [ExecutableNotFoundError](#ExecutableNotFoundError) + - [msg](#msg) +- [File](#File) + - [close](#close) + - [eof](#eof) + - [flush](#flush) + - [read](#read) + - [read_be](#read_be) + - [read_bytes](#read_bytes) + - [read_bytes_at](#read_bytes_at) + - [read_bytes_into](#read_bytes_into) + - [read_bytes_with_newline](#read_bytes_with_newline) + - [read_from](#read_from) + - [read_into_ptr](#read_into_ptr) + - [read_le](#read_le) + - [read_raw](#read_raw) + - [read_raw_at](#read_raw_at) + - [read_struct](#read_struct) + - [read_struct_at](#read_struct_at) + - [reopen](#reopen) + - [seek](#seek) + - [set_buffer](#set_buffer) + - [set_line_buffered](#set_line_buffered) + - [set_unbuffered](#set_unbuffered) + - [setvbuf](#setvbuf) + - [tell](#tell) + - [write](#write) + - [write_be](#write_be) + - [write_full_buffer](#write_full_buffer) + - [write_le](#write_le) + - [write_ptr](#write_ptr) + - [write_ptr_at](#write_ptr_at) + - [write_raw](#write_raw) + - [write_raw_at](#write_raw_at) + - [write_string](#write_string) + - [write_struct](#write_struct) + - [write_struct_at](#write_struct_at) + - [write_to](#write_to) + - [writeln](#writeln) +- [FileInfo](#FileInfo) +- [FileMode](#FileMode) + - [bitmask](#bitmask) +- [FileNotOpenedError](#FileNotOpenedError) + - [msg](#msg) +- [FilePermission](#FilePermission) + - [bitmask](#bitmask) +- [MkdirParams](#MkdirParams) +- [MvParams](#MvParams) +- [NotExpected](#NotExpected) +- [Process](#Process) + - [close](#close) + - [free](#free) + - [is_alive](#is_alive) + - [is_pending](#is_pending) + - [pipe_read](#pipe_read) + - [run](#run) + - [set_args](#set_args) + - [set_environment](#set_environment) + - [set_redirect_stdio](#set_redirect_stdio) + - [set_work_folder](#set_work_folder) + - [signal_continue](#signal_continue) + - [signal_kill](#signal_kill) + - [signal_pgkill](#signal_pgkill) + - [signal_stop](#signal_stop) + - [signal_term](#signal_term) + - [stderr_read](#stderr_read) + - [stderr_slurp](#stderr_slurp) + - [stdin_write](#stdin_write) + - [stdout_read](#stdout_read) + - [stdout_slurp](#stdout_slurp) + - [wait](#wait) +- [Result](#Result) + - [free](#free) +- [SizeOfTypeIs0Error](#SizeOfTypeIs0Error) + - [msg](#msg) +- [Stat](#Stat) + - [get_filetype](#get_filetype) + - [get_mode](#get_mode) +- [SystemError](#SystemError) +- [Uname](#Uname) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## abs_path +[[Return to contents]](#Contents) + +## args_after +[[Return to contents]](#Contents) + +## args_before +[[Return to contents]](#Contents) + +## base +[[Return to contents]](#Contents) + +## cache_dir +[[Return to contents]](#Contents) + +## chdir +[[Return to contents]](#Contents) + +## chmod +[[Return to contents]](#Contents) + +## chown +[[Return to contents]](#Contents) + +## config_dir +[[Return to contents]](#Contents) + +## cp +[[Return to contents]](#Contents) + +## cp_all +[[Return to contents]](#Contents) + +## create +[[Return to contents]](#Contents) + +## data_dir +[[Return to contents]](#Contents) + +## debugger_present +[[Return to contents]](#Contents) + +## dir +[[Return to contents]](#Contents) + +## disk_usage +[[Return to contents]](#Contents) + +## ensure_folder_is_writable +[[Return to contents]](#Contents) + +## environ +[[Return to contents]](#Contents) + +## error_posix +[[Return to contents]](#Contents) + +## error_win32 +[[Return to contents]](#Contents) + +## executable +[[Return to contents]](#Contents) + +## execute +[[Return to contents]](#Contents) + +## execute_opt +[[Return to contents]](#Contents) + +## execute_or_exit +[[Return to contents]](#Contents) + +## execute_or_panic +[[Return to contents]](#Contents) + +## execve +[[Return to contents]](#Contents) + +## execvp +[[Return to contents]](#Contents) + +## existing_path +[[Return to contents]](#Contents) + +## exists +[[Return to contents]](#Contents) + +## exists_in_system_path +[[Return to contents]](#Contents) + +## expand_tilde_to_home +[[Return to contents]](#Contents) + +## fd_close +[[Return to contents]](#Contents) + +## fd_is_pending +[[Return to contents]](#Contents) + +## fd_read +[[Return to contents]](#Contents) + +## fd_slurp +[[Return to contents]](#Contents) + +## fd_write +[[Return to contents]](#Contents) + +## file_ext +[[Return to contents]](#Contents) + +## file_last_mod_unix +[[Return to contents]](#Contents) + +## file_name +[[Return to contents]](#Contents) + +## file_size +[[Return to contents]](#Contents) + +## fileno +[[Return to contents]](#Contents) + +## find_abs_path_of_executable +[[Return to contents]](#Contents) + +## flush +[[Return to contents]](#Contents) + +## fork +[[Return to contents]](#Contents) + +## from_slash +[[Return to contents]](#Contents) + +## get_error_msg +[[Return to contents]](#Contents) + +## get_line +[[Return to contents]](#Contents) + +## get_lines +[[Return to contents]](#Contents) + +## get_lines_joined +[[Return to contents]](#Contents) + +## get_raw_line +[[Return to contents]](#Contents) + +## get_raw_lines +[[Return to contents]](#Contents) + +## get_raw_lines_joined +[[Return to contents]](#Contents) + +## get_raw_stdin +[[Return to contents]](#Contents) + +## get_trimmed_lines +[[Return to contents]](#Contents) + +## getegid +[[Return to contents]](#Contents) + +## getenv +[[Return to contents]](#Contents) + +## getenv_opt +[[Return to contents]](#Contents) + +## geteuid +[[Return to contents]](#Contents) + +## getgid +[[Return to contents]](#Contents) + +## getpid +[[Return to contents]](#Contents) + +## getppid +[[Return to contents]](#Contents) + +## getuid +[[Return to contents]](#Contents) + +## getwd +[[Return to contents]](#Contents) + +## glob +[[Return to contents]](#Contents) + +## home_dir +[[Return to contents]](#Contents) + +## hostname +[[Return to contents]](#Contents) + +## inode +[[Return to contents]](#Contents) + +## input +[[Return to contents]](#Contents) + +## input_opt +[[Return to contents]](#Contents) + +## input_password +[[Return to contents]](#Contents) + +## is_abs_path +[[Return to contents]](#Contents) + +## is_atty +[[Return to contents]](#Contents) + +## is_dir +[[Return to contents]](#Contents) + +## is_dir_empty +[[Return to contents]](#Contents) + +## is_executable +[[Return to contents]](#Contents) + +## is_file +[[Return to contents]](#Contents) + +## is_link +[[Return to contents]](#Contents) + +## is_main_thread +[[Return to contents]](#Contents) + +## is_readable +[[Return to contents]](#Contents) + +## is_writable +[[Return to contents]](#Contents) + +## join_path +[[Return to contents]](#Contents) + +## join_path_single +[[Return to contents]](#Contents) + +## last_error +[[Return to contents]](#Contents) + +## link +[[Return to contents]](#Contents) + +## local_bin_dir +[[Return to contents]](#Contents) + +## log +[[Return to contents]](#Contents) + +## loginname +[[Return to contents]](#Contents) + +## ls +Example +```v + +https://github.com/vlang/v/blob/master/examples/readdir.v + +``` + +[[Return to contents]](#Contents) + +## lstat +[[Return to contents]](#Contents) + +## mkdir +[[Return to contents]](#Contents) + +## mkdir_all +[[Return to contents]](#Contents) + +## mv +[[Return to contents]](#Contents) + +## mv_by_cp +[[Return to contents]](#Contents) + +## new_process +[[Return to contents]](#Contents) + +## norm_path +[[Return to contents]](#Contents) + +## open +[[Return to contents]](#Contents) + +## open_append +[[Return to contents]](#Contents) + +## open_file +[[Return to contents]](#Contents) + +## open_uri +[[Return to contents]](#Contents) + +## page_size +[[Return to contents]](#Contents) + +## posix_get_error_msg +[[Return to contents]](#Contents) + +## posix_set_permission_bit +[[Return to contents]](#Contents) + +## quoted_path +[[Return to contents]](#Contents) + +## raw_execute +[[Return to contents]](#Contents) + +## read_bytes +[[Return to contents]](#Contents) + +## read_file +[[Return to contents]](#Contents) + +## read_file_array +[[Return to contents]](#Contents) + +## read_lines +[[Return to contents]](#Contents) + +## real_path +[[Return to contents]](#Contents) + +## rename +[[Return to contents]](#Contents) + +## rename_dir +[[Return to contents]](#Contents) + +## resource_abs_path +[[Return to contents]](#Contents) + +## rm +[[Return to contents]](#Contents) + +## rmdir +[[Return to contents]](#Contents) + +## rmdir_all +[[Return to contents]](#Contents) + +## setenv +[[Return to contents]](#Contents) + +## sigint_to_signal_name +[[Return to contents]](#Contents) + +## signal_ignore +[[Return to contents]](#Contents) + +## signal_opt +[[Return to contents]](#Contents) + +## split_path +[[Return to contents]](#Contents) + +## stat +[[Return to contents]](#Contents) + +## state_dir +[[Return to contents]](#Contents) + +## stderr +[[Return to contents]](#Contents) + +## stdin +[[Return to contents]](#Contents) + +## stdout +[[Return to contents]](#Contents) + +## symlink +[[Return to contents]](#Contents) + +## system +[[Return to contents]](#Contents) + +## temp_dir +[[Return to contents]](#Contents) + +## to_slash +[[Return to contents]](#Contents) + +## truncate +[[Return to contents]](#Contents) + +## uname +[[Return to contents]](#Contents) + +## unsetenv +[[Return to contents]](#Contents) + +## user_names +[[Return to contents]](#Contents) + +## user_os +[[Return to contents]](#Contents) + +## utime +[[Return to contents]](#Contents) + +## vfopen +[[Return to contents]](#Contents) + +## vmodules_dir +[[Return to contents]](#Contents) + +## vmodules_paths +[[Return to contents]](#Contents) + +## vtmp_dir +[[Return to contents]](#Contents) + +## wait +[[Return to contents]](#Contents) + +## walk +[[Return to contents]](#Contents) + +## walk_ext +[[Return to contents]](#Contents) + +## walk_with_context +[[Return to contents]](#Contents) + +## write_file +[[Return to contents]](#Contents) + +## write_file_array +[[Return to contents]](#Contents) + +## write_lines +[[Return to contents]](#Contents) + +## FN_SA_Handler +[[Return to contents]](#Contents) + +## FnWalkContextCB +[[Return to contents]](#Contents) + +## SignalHandler +[[Return to contents]](#Contents) + +## ChildProcessPipeKind +[[Return to contents]](#Contents) + +## FileBufferMode +[[Return to contents]](#Contents) + +## FileType +[[Return to contents]](#Contents) + +## ProcessState +[[Return to contents]](#Contents) + +## SeekMode +[[Return to contents]](#Contents) + +## Signal +[[Return to contents]](#Contents) + +## C.__stat64 +[[Return to contents]](#Contents) + +## C.dirent +[[Return to contents]](#Contents) + +## C.fd_set +[[Return to contents]](#Contents) + +## C.sigaction +[[Return to contents]](#Contents) + +## C.stat +[[Return to contents]](#Contents) + +## C.timespec +[[Return to contents]](#Contents) + +## C.timeval +[[Return to contents]](#Contents) + +## C.utimbuf +[[Return to contents]](#Contents) + +## C.utsname +[[Return to contents]](#Contents) + +## Command +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## read_line +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +## DiskUsage +[[Return to contents]](#Contents) + +## Eof +[[Return to contents]](#Contents) + +## ExecutableNotFoundError +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## File +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## eof +[[Return to contents]](#Contents) + +## flush +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## read_be +[[Return to contents]](#Contents) + +## read_bytes +[[Return to contents]](#Contents) + +## read_bytes_at +[[Return to contents]](#Contents) + +## read_bytes_into +[[Return to contents]](#Contents) + +## read_bytes_with_newline +[[Return to contents]](#Contents) + +## read_from +[[Return to contents]](#Contents) + +## read_into_ptr +[[Return to contents]](#Contents) + +## read_le +[[Return to contents]](#Contents) + +## read_raw +[[Return to contents]](#Contents) + +## read_raw_at +[[Return to contents]](#Contents) + +## read_struct +[[Return to contents]](#Contents) + +## read_struct_at +[[Return to contents]](#Contents) + +## reopen +[[Return to contents]](#Contents) + +## seek +[[Return to contents]](#Contents) + +## set_buffer +[[Return to contents]](#Contents) + +## set_line_buffered +[[Return to contents]](#Contents) + +## set_unbuffered +[[Return to contents]](#Contents) + +## setvbuf +[[Return to contents]](#Contents) + +## tell +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## write_be +[[Return to contents]](#Contents) + +## write_full_buffer +[[Return to contents]](#Contents) + +## write_le +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write_ptr_at +[[Return to contents]](#Contents) + +## write_raw +[[Return to contents]](#Contents) + +## write_raw_at +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## write_struct +[[Return to contents]](#Contents) + +## write_struct_at +[[Return to contents]](#Contents) + +## write_to +[[Return to contents]](#Contents) + +## writeln +[[Return to contents]](#Contents) + +## FileInfo +[[Return to contents]](#Contents) + +## FileMode +[[Return to contents]](#Contents) + +## bitmask +[[Return to contents]](#Contents) + +## FileNotOpenedError +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## FilePermission +[[Return to contents]](#Contents) + +## bitmask +[[Return to contents]](#Contents) + +## MkdirParams +[[Return to contents]](#Contents) + +## MvParams +[[Return to contents]](#Contents) + +## NotExpected +[[Return to contents]](#Contents) + +## Process +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## is_alive +[[Return to contents]](#Contents) + +## is_pending +[[Return to contents]](#Contents) + +## pipe_read +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## set_args +[[Return to contents]](#Contents) + +## set_environment +[[Return to contents]](#Contents) + +## set_redirect_stdio +[[Return to contents]](#Contents) + +## set_work_folder +[[Return to contents]](#Contents) + +## signal_continue +[[Return to contents]](#Contents) + +## signal_kill +[[Return to contents]](#Contents) + +## signal_pgkill +[[Return to contents]](#Contents) + +## signal_stop +[[Return to contents]](#Contents) + +## signal_term +[[Return to contents]](#Contents) + +## stderr_read +[[Return to contents]](#Contents) + +## stderr_slurp +[[Return to contents]](#Contents) + +## stdin_write +[[Return to contents]](#Contents) + +## stdout_read +[[Return to contents]](#Contents) + +## stdout_slurp +[[Return to contents]](#Contents) + +## wait +[[Return to contents]](#Contents) + +## Result +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## SizeOfTypeIs0Error +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## Stat +[[Return to contents]](#Contents) + +## get_filetype +[[Return to contents]](#Contents) + +## get_mode +[[Return to contents]](#Contents) + +## SystemError +[[Return to contents]](#Contents) + +## Uname +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/os.notify.md b/vdocs/os.notify.md new file mode 100644 index 00000000..1ede4a88 --- /dev/null +++ b/vdocs/os.notify.md @@ -0,0 +1,30 @@ +# module os.notify + + +## Contents +- [new](#new) +- [FdEvent](#FdEvent) +- [FdNotifier](#FdNotifier) +- [FdConfigFlags](#FdConfigFlags) +- [FdEventType](#FdEventType) +- [C.kevent](#C.kevent) + +## new +[[Return to contents]](#Contents) + +## FdEvent +[[Return to contents]](#Contents) + +## FdNotifier +[[Return to contents]](#Contents) + +## FdConfigFlags +[[Return to contents]](#Contents) + +## FdEventType +[[Return to contents]](#Contents) + +## C.kevent +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/picoev.md b/vdocs/picoev.md new file mode 100644 index 00000000..ec705555 --- /dev/null +++ b/vdocs/picoev.md @@ -0,0 +1,76 @@ +# module picoev + + +## Contents +- [Constants](#Constants) +- [create_kqueue_loop](#create_kqueue_loop) +- [new](#new) +- [C.kevent](#C.kevent) +- [Config](#Config) +- [KqueueLoop](#KqueueLoop) +- [Picoev](#Picoev) + - [add](#add) + - [close_conn](#close_conn) + - [delete](#delete) + - [ev_set](#ev_set) + - [init](#init) + - [serve](#serve) +- [Target](#Target) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## create_kqueue_loop +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## C.kevent +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## KqueueLoop +[[Return to contents]](#Contents) + +## Picoev +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## close_conn +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## ev_set +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## serve +[[Return to contents]](#Contents) + +## Target +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/picohttpparser.md b/vdocs/picohttpparser.md new file mode 100644 index 00000000..658ef7e6 --- /dev/null +++ b/vdocs/picohttpparser.md @@ -0,0 +1,94 @@ +# module picohttpparser + + +## Contents +- [u64toa](#u64toa) +- [Header](#Header) +- [Request](#Request) + - [parse_request](#parse_request) + - [parse_request_path](#parse_request_path) + - [parse_request_path_pipeline](#parse_request_path_pipeline) +- [Response](#Response) + - [write_string](#write_string) + - [http_ok](#http_ok) + - [header](#header) + - [header_date](#header_date) + - [header_server](#header_server) + - [content_type](#content_type) + - [html](#html) + - [plain](#plain) + - [json](#json) + - [body](#body) + - [http_404](#http_404) + - [http_405](#http_405) + - [http_500](#http_500) + - [raw](#raw) + - [end](#end) + +## u64toa +[[Return to contents]](#Contents) + +## Header +[[Return to contents]](#Contents) + +## Request +[[Return to contents]](#Contents) + +## parse_request +[[Return to contents]](#Contents) + +## parse_request_path +[[Return to contents]](#Contents) + +## parse_request_path_pipeline +[[Return to contents]](#Contents) + +## Response +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## http_ok +[[Return to contents]](#Contents) + +## header +[[Return to contents]](#Contents) + +## header_date +[[Return to contents]](#Contents) + +## header_server +[[Return to contents]](#Contents) + +## content_type +[[Return to contents]](#Contents) + +## html +[[Return to contents]](#Contents) + +## plain +[[Return to contents]](#Contents) + +## json +[[Return to contents]](#Contents) + +## body +[[Return to contents]](#Contents) + +## http_404 +[[Return to contents]](#Contents) + +## http_405 +[[Return to contents]](#Contents) + +## http_500 +[[Return to contents]](#Contents) + +## raw +[[Return to contents]](#Contents) + +## end +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.buffer.md b/vdocs/rand.buffer.md new file mode 100644 index 00000000..62b1d648 --- /dev/null +++ b/vdocs/rand.buffer.md @@ -0,0 +1,10 @@ +# module rand.buffer + + +## Contents +- [PRNGBuffer](#PRNGBuffer) + +## PRNGBuffer +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.config.md b/vdocs/rand.config.md new file mode 100644 index 00000000..8c3bfac7 --- /dev/null +++ b/vdocs/rand.config.md @@ -0,0 +1,22 @@ +# module rand.config + + +## Contents +- [NormalConfigStruct](#NormalConfigStruct) +- [PRNGConfigStruct](#PRNGConfigStruct) +- [ShuffleConfigStruct](#ShuffleConfigStruct) + - [validate_for](#validate_for) + +## NormalConfigStruct +[[Return to contents]](#Contents) + +## PRNGConfigStruct +[[Return to contents]](#Contents) + +## ShuffleConfigStruct +[[Return to contents]](#Contents) + +## validate_for +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.cuid2.md b/vdocs/rand.cuid2.md new file mode 100644 index 00000000..f4909887 --- /dev/null +++ b/vdocs/rand.cuid2.md @@ -0,0 +1,34 @@ +# module rand.cuid2 + + +## Contents +- [is_cuid](#is_cuid) +- [new](#new) +- [Cuid2Generator](#Cuid2Generator) + - [generate](#generate) + - [cuid2](#cuid2) + - [next](#next) +- [Cuid2Param](#Cuid2Param) + +## is_cuid +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## Cuid2Generator +[[Return to contents]](#Contents) + +## generate +[[Return to contents]](#Contents) + +## cuid2 +[[Return to contents]](#Contents) + +## next +[[Return to contents]](#Contents) + +## Cuid2Param +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.md b/vdocs/rand.md new file mode 100644 index 00000000..6d4cd901 --- /dev/null +++ b/vdocs/rand.md @@ -0,0 +1,394 @@ +# module rand + + +## Contents +- [ascii](#ascii) +- [bernoulli](#bernoulli) +- [binomial](#binomial) +- [bytes](#bytes) +- [choose](#choose) +- [element](#element) +- [exponential](#exponential) +- [f32](#f32) +- [f32_in_range](#f32_in_range) +- [f32cp](#f32cp) +- [f32n](#f32n) +- [f64](#f64) +- [f64_in_range](#f64_in_range) +- [f64cp](#f64cp) +- [f64n](#f64n) +- [fill_buffer_from_set](#fill_buffer_from_set) +- [get_current_rng](#get_current_rng) +- [hex](#hex) +- [i16](#i16) +- [i32](#i32) +- [i32_in_range](#i32_in_range) +- [i32n](#i32n) +- [i64](#i64) +- [i64_in_range](#i64_in_range) +- [i64n](#i64n) +- [int](#int) +- [int31](#int31) +- [int63](#int63) +- [int_in_range](#int_in_range) +- [intn](#intn) +- [new_default](#new_default) +- [normal](#normal) +- [normal_pair](#normal_pair) +- [read](#read) +- [sample](#sample) +- [seed](#seed) +- [set_rng](#set_rng) +- [shuffle](#shuffle) +- [shuffle_clone](#shuffle_clone) +- [string](#string) +- [string_from_set](#string_from_set) +- [u16](#u16) +- [u32](#u32) +- [u32_in_range](#u32_in_range) +- [u32n](#u32n) +- [u64](#u64) +- [u64_in_range](#u64_in_range) +- [u64n](#u64n) +- [u8](#u8) +- [ulid](#ulid) +- [ulid_at_millisecond](#ulid_at_millisecond) +- [uuid_v4](#uuid_v4) +- [PRNG](#PRNG) + - [bytes](#bytes) + - [read](#read) + - [i32n](#i32n) + - [u32n](#u32n) + - [u64n](#u64n) + - [u32_in_range](#u32_in_range) + - [u64_in_range](#u64_in_range) + - [i8](#i8) + - [i16](#i16) + - [i32](#i32) + - [int](#int) + - [i64](#i64) + - [int31](#int31) + - [int63](#int63) + - [intn](#intn) + - [i64n](#i64n) + - [int_in_range](#int_in_range) + - [i32_in_range](#i32_in_range) + - [i64_in_range](#i64_in_range) + - [f32](#f32) + - [f32cp](#f32cp) + - [f64](#f64) + - [f64cp](#f64cp) + - [f32n](#f32n) + - [f64n](#f64n) + - [f32_in_range](#f32_in_range) + - [f64_in_range](#f64_in_range) + - [ulid](#ulid) + - [ulid_at_millisecond](#ulid_at_millisecond) + - [string_from_set](#string_from_set) + - [string](#string) + - [hex](#hex) + - [ascii](#ascii) + - [fill_buffer_from_set](#fill_buffer_from_set) + - [bernoulli](#bernoulli) + - [normal](#normal) + - [normal_pair](#normal_pair) + - [binomial](#binomial) + - [exponential](#exponential) + - [shuffle](#shuffle) + - [shuffle_clone](#shuffle_clone) + - [choose](#choose) + - [element](#element) + - [sample](#sample) + +## ascii +[[Return to contents]](#Contents) + +## bernoulli +[[Return to contents]](#Contents) + +## binomial +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## choose +[[Return to contents]](#Contents) + +## element +[[Return to contents]](#Contents) + +## exponential +[[Return to contents]](#Contents) + +## f32 +[[Return to contents]](#Contents) + +## f32_in_range +[[Return to contents]](#Contents) + +## f32cp +[[Return to contents]](#Contents) + +## f32n +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## f64_in_range +[[Return to contents]](#Contents) + +## f64cp +[[Return to contents]](#Contents) + +## f64n +[[Return to contents]](#Contents) + +## fill_buffer_from_set +[[Return to contents]](#Contents) + +## get_current_rng +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## i16 +[[Return to contents]](#Contents) + +## i32 +[[Return to contents]](#Contents) + +## i32_in_range +[[Return to contents]](#Contents) + +## i32n +[[Return to contents]](#Contents) + +## i64 +[[Return to contents]](#Contents) + +## i64_in_range +[[Return to contents]](#Contents) + +## i64n +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## int31 +[[Return to contents]](#Contents) + +## int63 +[[Return to contents]](#Contents) + +## int_in_range +[[Return to contents]](#Contents) + +## intn +[[Return to contents]](#Contents) + +## new_default +[[Return to contents]](#Contents) + +## normal +[[Return to contents]](#Contents) + +## normal_pair +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## sample +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## set_rng +[[Return to contents]](#Contents) + +## shuffle +[[Return to contents]](#Contents) + +## shuffle_clone +[[Return to contents]](#Contents) + +## string +[[Return to contents]](#Contents) + +## string_from_set +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u32_in_range +[[Return to contents]](#Contents) + +## u32n +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## u64_in_range +[[Return to contents]](#Contents) + +## u64n +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## ulid +[[Return to contents]](#Contents) + +## ulid_at_millisecond +[[Return to contents]](#Contents) + +## uuid_v4 +[[Return to contents]](#Contents) + +## PRNG +[[Return to contents]](#Contents) + +## bytes +[[Return to contents]](#Contents) + +## read +[[Return to contents]](#Contents) + +## i32n +[[Return to contents]](#Contents) + +## u32n +[[Return to contents]](#Contents) + +## u64n +[[Return to contents]](#Contents) + +## u32_in_range +[[Return to contents]](#Contents) + +## u64_in_range +[[Return to contents]](#Contents) + +## i8 +[[Return to contents]](#Contents) + +## i16 +[[Return to contents]](#Contents) + +## i32 +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## i64 +[[Return to contents]](#Contents) + +## int31 +[[Return to contents]](#Contents) + +## int63 +[[Return to contents]](#Contents) + +## intn +[[Return to contents]](#Contents) + +## i64n +[[Return to contents]](#Contents) + +## int_in_range +[[Return to contents]](#Contents) + +## i32_in_range +[[Return to contents]](#Contents) + +## i64_in_range +[[Return to contents]](#Contents) + +## f32 +[[Return to contents]](#Contents) + +## f32cp +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## f64cp +[[Return to contents]](#Contents) + +## f32n +[[Return to contents]](#Contents) + +## f64n +[[Return to contents]](#Contents) + +## f32_in_range +[[Return to contents]](#Contents) + +## f64_in_range +[[Return to contents]](#Contents) + +## ulid +[[Return to contents]](#Contents) + +## ulid_at_millisecond +[[Return to contents]](#Contents) + +## string_from_set +[[Return to contents]](#Contents) + +## string +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## ascii +[[Return to contents]](#Contents) + +## fill_buffer_from_set +[[Return to contents]](#Contents) + +## bernoulli +[[Return to contents]](#Contents) + +## normal +[[Return to contents]](#Contents) + +## normal_pair +[[Return to contents]](#Contents) + +## binomial +[[Return to contents]](#Contents) + +## exponential +[[Return to contents]](#Contents) + +## shuffle +[[Return to contents]](#Contents) + +## shuffle_clone +[[Return to contents]](#Contents) + +## choose +[[Return to contents]](#Contents) + +## element +[[Return to contents]](#Contents) + +## sample +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.mt19937.md b/vdocs/rand.mt19937.md new file mode 100644 index 00000000..4a4d1ed7 --- /dev/null +++ b/vdocs/rand.mt19937.md @@ -0,0 +1,42 @@ +# module rand.mt19937 + + +## Contents +- [Constants](#Constants) +- [MT19937RNG](#MT19937RNG) + - [seed](#seed) + - [u8](#u8) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [block_size](#block_size) + - [free](#free) + +## Constants +[[Return to contents]](#Contents) + +## MT19937RNG +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.musl.md b/vdocs/rand.musl.md new file mode 100644 index 00000000..a744c16e --- /dev/null +++ b/vdocs/rand.musl.md @@ -0,0 +1,42 @@ +# module rand.musl + + +## Contents +- [Constants](#Constants) +- [MuslRNG](#MuslRNG) + - [seed](#seed) + - [u8](#u8) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [block_size](#block_size) + - [free](#free) + +## Constants +[[Return to contents]](#Contents) + +## MuslRNG +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.pcg32.md b/vdocs/rand.pcg32.md new file mode 100644 index 00000000..cf2381e1 --- /dev/null +++ b/vdocs/rand.pcg32.md @@ -0,0 +1,42 @@ +# module rand.pcg32 + + +## Contents +- [Constants](#Constants) +- [PCG32RNG](#PCG32RNG) + - [seed](#seed) + - [u8](#u8) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [block_size](#block_size) + - [free](#free) + +## Constants +[[Return to contents]](#Contents) + +## PCG32RNG +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.seed.md b/vdocs/rand.seed.md new file mode 100644 index 00000000..b0c1daf3 --- /dev/null +++ b/vdocs/rand.seed.md @@ -0,0 +1,18 @@ +# module rand.seed + + +## Contents +- [time_seed_32](#time_seed_32) +- [time_seed_64](#time_seed_64) +- [time_seed_array](#time_seed_array) + +## time_seed_32 +[[Return to contents]](#Contents) + +## time_seed_64 +[[Return to contents]](#Contents) + +## time_seed_array +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.splitmix64.md b/vdocs/rand.splitmix64.md new file mode 100644 index 00000000..80948d30 --- /dev/null +++ b/vdocs/rand.splitmix64.md @@ -0,0 +1,42 @@ +# module rand.splitmix64 + + +## Contents +- [Constants](#Constants) +- [SplitMix64RNG](#SplitMix64RNG) + - [seed](#seed) + - [u8](#u8) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [block_size](#block_size) + - [free](#free) + +## Constants +[[Return to contents]](#Contents) + +## SplitMix64RNG +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.sys.md b/vdocs/rand.sys.md new file mode 100644 index 00000000..0f48a363 --- /dev/null +++ b/vdocs/rand.sys.md @@ -0,0 +1,46 @@ +# module rand.sys + + +## Contents +- [Constants](#Constants) +- [SysRNG](#SysRNG) + - [seed](#seed) + - [default_rand](#default_rand) + - [u8](#u8) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [block_size](#block_size) + - [free](#free) + +## Constants +[[Return to contents]](#Contents) + +## SysRNG +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## default_rand +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.wyrand.md b/vdocs/rand.wyrand.md new file mode 100644 index 00000000..11fada48 --- /dev/null +++ b/vdocs/rand.wyrand.md @@ -0,0 +1,42 @@ +# module rand.wyrand + + +## Contents +- [Constants](#Constants) +- [WyRandRNG](#WyRandRNG) + - [block_size](#block_size) + - [free](#free) + - [seed](#seed) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [u8](#u8) + +## Constants +[[Return to contents]](#Contents) + +## WyRandRNG +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/rand.xoroshiro128pp.md b/vdocs/rand.xoroshiro128pp.md new file mode 100644 index 00000000..37db8796 --- /dev/null +++ b/vdocs/rand.xoroshiro128pp.md @@ -0,0 +1,42 @@ +# module rand.xoroshiro128pp + + +## Contents +- [Constants](#Constants) +- [XOROS128PPRNG](#XOROS128PPRNG) + - [seed](#seed) + - [u8](#u8) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [block_size](#block_size) + - [free](#free) + +## Constants +[[Return to contents]](#Contents) + +## XOROS128PPRNG +[[Return to contents]](#Contents) + +## seed +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## block_size +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/readline.md b/vdocs/readline.md new file mode 100644 index 00000000..c7539a74 --- /dev/null +++ b/vdocs/readline.md @@ -0,0 +1,49 @@ +# module readline + + +## Contents +- [read_line](#read_line) +- [read_line_utf8](#read_line_utf8) +- [Readline](#Readline) + - [disable_raw_mode](#disable_raw_mode) + - [enable_raw_mode](#enable_raw_mode) + - [enable_raw_mode_nosig](#enable_raw_mode_nosig) + - [read_char](#read_char) + - [read_line](#read_line) + - [read_line_utf8](#read_line_utf8) + +## read_line +[[Return to contents]](#Contents) + +## read_line_utf8 +[[Return to contents]](#Contents) + +## Readline +Example +```v + +import readline { Readline } + +``` + +[[Return to contents]](#Contents) + +## disable_raw_mode +[[Return to contents]](#Contents) + +## enable_raw_mode +[[Return to contents]](#Contents) + +## enable_raw_mode_nosig +[[Return to contents]](#Contents) + +## read_char +[[Return to contents]](#Contents) + +## read_line +[[Return to contents]](#Contents) + +## read_line_utf8 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/regex.md b/vdocs/regex.md new file mode 100644 index 00000000..5622defe --- /dev/null +++ b/vdocs/regex.md @@ -0,0 +1,174 @@ +# module regex + + +## Contents +- [Constants](#Constants) +- [new](#new) +- [regex_base](#regex_base) +- [regex_opt](#regex_opt) +- [FnLog](#FnLog) +- [FnReplace](#FnReplace) +- [FnValidator](#FnValidator) +- [RE](#RE) + - [compile_opt](#compile_opt) + - [find](#find) + - [find_all](#find_all) + - [find_all_str](#find_all_str) + - [find_from](#find_from) + - [get_code](#get_code) + - [get_group_bounds_by_id](#get_group_bounds_by_id) + - [get_group_bounds_by_name](#get_group_bounds_by_name) + - [get_group_by_id](#get_group_by_id) + - [get_group_by_name](#get_group_by_name) + - [get_group_list](#get_group_list) + - [get_query](#get_query) + - [match_base](#match_base) + - [match_string](#match_string) + - [matches_string](#matches_string) + - [replace](#replace) + - [replace_by_fn](#replace_by_fn) + - [replace_n](#replace_n) + - [replace_simple](#replace_simple) + - [reset](#reset) + - [split](#split) +- [Re_group](#Re_group) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## regex_base +[[Return to contents]](#Contents) + +## regex_opt +[[Return to contents]](#Contents) + +## FnLog +[[Return to contents]](#Contents) + +## FnReplace +[[Return to contents]](#Contents) + +## FnValidator +[[Return to contents]](#Contents) + +## RE +[[Return to contents]](#Contents) + +## compile_opt +[[Return to contents]](#Contents) + +## find +[[Return to contents]](#Contents) + +## find_all +[[Return to contents]](#Contents) + +## find_all_str +[[Return to contents]](#Contents) + +## find_from +[[Return to contents]](#Contents) + +## get_code +[[Return to contents]](#Contents) + +## get_group_bounds_by_id +[[Return to contents]](#Contents) + +## get_group_bounds_by_name +[[Return to contents]](#Contents) + +## get_group_by_id +[[Return to contents]](#Contents) + +## get_group_by_name +[[Return to contents]](#Contents) + +## get_group_list +[[Return to contents]](#Contents) + +## get_query +[[Return to contents]](#Contents) + +## match_base +[[Return to contents]](#Contents) + +## match_string +[[Return to contents]](#Contents) + +## matches_string +[[Return to contents]](#Contents) + +## replace +[[Return to contents]](#Contents) + +## replace_by_fn +[[Return to contents]](#Contents) + +## replace_n +[[Return to contents]](#Contents) + +## replace_simple +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## split +[[Return to contents]](#Contents) + +## Re_group +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/runtime.md b/vdocs/runtime.md new file mode 100644 index 00000000..1d9128a3 --- /dev/null +++ b/vdocs/runtime.md @@ -0,0 +1,50 @@ +# module runtime + + +## Contents +- [free_memory](#free_memory) +- [is_32bit](#is_32bit) +- [is_64bit](#is_64bit) +- [is_big_endian](#is_big_endian) +- [is_little_endian](#is_little_endian) +- [nr_cpus](#nr_cpus) +- [nr_jobs](#nr_jobs) +- [total_memory](#total_memory) +- [C.host_t](#C.host_t) +- [C.vm_size_t](#C.vm_size_t) +- [C.vm_statistics64_data_t](#C.vm_statistics64_data_t) + +## free_memory +[[Return to contents]](#Contents) + +## is_32bit +[[Return to contents]](#Contents) + +## is_64bit +[[Return to contents]](#Contents) + +## is_big_endian +[[Return to contents]](#Contents) + +## is_little_endian +[[Return to contents]](#Contents) + +## nr_cpus +[[Return to contents]](#Contents) + +## nr_jobs +[[Return to contents]](#Contents) + +## total_memory +[[Return to contents]](#Contents) + +## C.host_t +[[Return to contents]](#Contents) + +## C.vm_size_t +[[Return to contents]](#Contents) + +## C.vm_statistics64_data_t +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/semver.md b/vdocs/semver.md new file mode 100644 index 00000000..60b15e66 --- /dev/null +++ b/vdocs/semver.md @@ -0,0 +1,71 @@ +# module semver + + +## Contents +- [build](#build) +- [coerce](#coerce) +- [from](#from) +- [is_valid](#is_valid) +- [EmptyInputError](#EmptyInputError) + - [msg](#msg) +- [InvalidVersionFormatError](#InvalidVersionFormatError) + - [msg](#msg) +- [Increment](#Increment) +- [Version](#Version) + - [increment](#increment) + - [satisfies](#satisfies) + - [==](#==) + - [<](#<) + - [str](#str) + +## build +[[Return to contents]](#Contents) + +## coerce +[[Return to contents]](#Contents) + +## from +[[Return to contents]](#Contents) + +## is_valid +[[Return to contents]](#Contents) + +## EmptyInputError +## msg +[[Return to contents]](#Contents) + +## InvalidVersionFormatError +## msg +[[Return to contents]](#Contents) + +## Increment +[[Return to contents]](#Contents) + +## Version +[[Return to contents]](#Contents) + +## increment +[[Return to contents]](#Contents) + +## satisfies +Examples +```v + +assert semver.build(1,0,0).satisfies('<=2.0.0') == true + +assert semver.build(1,0,0).satisfies('>=2.0.0') == false + +``` + +[[Return to contents]](#Contents) + +## == +[[Return to contents]](#Contents) + +## < +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sokol.audio.md b/vdocs/sokol.audio.md new file mode 100644 index 00000000..11942f06 --- /dev/null +++ b/vdocs/sokol.audio.md @@ -0,0 +1,133 @@ +# module sokol.audio + + +## Contents +- [buffer_frames](#buffer_frames) +- [channels](#channels) +- [expect](#expect) +- [fclamp](#fclamp) +- [is_valid](#is_valid) +- [max](#max) +- [min](#min) +- [push](#push) +- [query](#query) +- [sample_rate](#sample_rate) +- [setup](#setup) +- [shutdown](#shutdown) +- [suspended](#suspended) +- [user_data](#user_data) +- [FNStreamingCB](#FNStreamingCB) + - [str](#str) +- [FnStreamingCBWithUserData](#FnStreamingCBWithUserData) + - [str](#str) +- [C.saudio_allocator](#C.saudio_allocator) +- [C.saudio_desc](#C.saudio_desc) +- [C.saudio_logger](#C.saudio_logger) + +## buffer_frames +[[Return to contents]](#Contents) + +## channels +[[Return to contents]](#Contents) + +## expect +[[Return to contents]](#Contents) + +## fclamp +Example +```v + +realsample := audio.fclamp(sample, -1.0, 1.0) + +``` + +[[Return to contents]](#Contents) + +## is_valid +[[Return to contents]](#Contents) + +## max +Example +```v + +larger := audio.max(1, 5) // larger == 5 + +``` + +[[Return to contents]](#Contents) + +## min +Example +```v + +smaller := audio.min(1, 5) // smaller == 1 + +``` + +[[Return to contents]](#Contents) + +## push +[[Return to contents]](#Contents) + +## query +[[Return to contents]](#Contents) + +## sample_rate +[[Return to contents]](#Contents) + +## setup +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## suspended +[[Return to contents]](#Contents) + +## user_data +[[Return to contents]](#Contents) + +## FNStreamingCB +Examples +```v + +unsafe { C.memcpy(buffer, &samples, samples.len * int(sizeof(f32))) } + +unsafe { mut b := buffer; for i, sample in samples { b[i] = sample } } + +``` + +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## FnStreamingCBWithUserData +Examples +```v + +mut soundbuffer := []f32 + +soundbuffer << previously_parsed_wavfile_bytes + +audio.setup(stream_userdata_cb: mycallback, user_data: soundbuffer) + +fn mycallback(buffer &f32, num_frames int, num_channels int, mut sb []f32) { ... } + +``` + +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## C.saudio_allocator +[[Return to contents]](#Contents) + +## C.saudio_desc +[[Return to contents]](#Contents) + +## C.saudio_logger +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sokol.gfx.md b/vdocs/sokol.gfx.md new file mode 100644 index 00000000..3d3a632f --- /dev/null +++ b/vdocs/sokol.gfx.md @@ -0,0 +1,1050 @@ +# module sokol.gfx + + +## Contents +- [Constants](#Constants) +- [append_buffer](#append_buffer) +- [apply_bindings](#apply_bindings) +- [apply_pipeline](#apply_pipeline) +- [apply_scissor_rect](#apply_scissor_rect) +- [apply_uniforms](#apply_uniforms) +- [apply_viewport](#apply_viewport) +- [begin_pass](#begin_pass) +- [commit](#commit) +- [create_clear_pass_action](#create_clear_pass_action) +- [destroy_attachments](#destroy_attachments) +- [destroy_buffer](#destroy_buffer) +- [destroy_image](#destroy_image) +- [destroy_pipeline](#destroy_pipeline) +- [destroy_sampler](#destroy_sampler) +- [destroy_shader](#destroy_shader) +- [disable_frame_stats](#disable_frame_stats) +- [draw](#draw) +- [enable_frame_stats](#enable_frame_stats) +- [end_pass](#end_pass) +- [frame_stats_enabled](#frame_stats_enabled) +- [is_valid](#is_valid) +- [make_attachments](#make_attachments) +- [make_buffer](#make_buffer) +- [make_image](#make_image) +- [make_pipeline](#make_pipeline) +- [make_sampler](#make_sampler) +- [make_shader](#make_shader) +- [query_attachments_defaults](#query_attachments_defaults) +- [query_attachments_info](#query_attachments_info) +- [query_attachments_state](#query_attachments_state) +- [query_backend](#query_backend) +- [query_buffer_defaults](#query_buffer_defaults) +- [query_buffer_info](#query_buffer_info) +- [query_buffer_overflow](#query_buffer_overflow) +- [query_buffer_state](#query_buffer_state) +- [query_desc](#query_desc) +- [query_features](#query_features) +- [query_frame_stats](#query_frame_stats) +- [query_image_defaults](#query_image_defaults) +- [query_image_info](#query_image_info) +- [query_image_state](#query_image_state) +- [query_limits](#query_limits) +- [query_pipeline_defaults](#query_pipeline_defaults) +- [query_pipeline_info](#query_pipeline_info) +- [query_pipeline_state](#query_pipeline_state) +- [query_pixelformat](#query_pixelformat) +- [query_shader_defaults](#query_shader_defaults) +- [query_shader_info](#query_shader_info) +- [query_shader_state](#query_shader_state) +- [reset_state_cache](#reset_state_cache) +- [setup](#setup) +- [shutdown](#shutdown) +- [update_buffer](#update_buffer) +- [update_image](#update_image) +- [AttachmentDesc](#AttachmentDesc) +- [Attachments](#Attachments) +- [AttachmentsDesc](#AttachmentsDesc) +- [AttachmentsInfo](#AttachmentsInfo) +- [Bindings](#Bindings) + - [set_vert_image](#set_vert_image) + - [set_frag_image](#set_frag_image) + - [update_vert_buffer](#update_vert_buffer) + - [append_vert_buffer](#append_vert_buffer) + - [update_index_buffer](#update_index_buffer) + - [append_index_buffer](#append_index_buffer) +- [BlendState](#BlendState) +- [Buffer](#Buffer) + - [free](#free) +- [BufferDesc](#BufferDesc) +- [BufferInfo](#BufferInfo) +- [Color](#Color) +- [ColorAttachmentAction](#ColorAttachmentAction) +- [ColorTargetState](#ColorTargetState) +- [CommitListener](#CommitListener) +- [D3d11Environment](#D3d11Environment) +- [D3d11Swapchain](#D3d11Swapchain) +- [DepthAttachmentAction](#DepthAttachmentAction) +- [DepthState](#DepthState) +- [Desc](#Desc) +- [Environment](#Environment) +- [EnvironmentDefaults](#EnvironmentDefaults) +- [Features](#Features) +- [FrameStats](#FrameStats) +- [FrameStatsD3D11](#FrameStatsD3D11) +- [FrameStatsD3D11Bindings](#FrameStatsD3D11Bindings) +- [FrameStatsD3D11Draw](#FrameStatsD3D11Draw) +- [FrameStatsD3D11Pass](#FrameStatsD3D11Pass) +- [FrameStatsD3D11Pipeline](#FrameStatsD3D11Pipeline) +- [FrameStatsD3D11Uniforms](#FrameStatsD3D11Uniforms) +- [FrameStatsGL](#FrameStatsGL) +- [FrameStatsMetal](#FrameStatsMetal) +- [FrameStatsMetalBindings](#FrameStatsMetalBindings) +- [FrameStatsMetalIdpool](#FrameStatsMetalIdpool) +- [FrameStatsMetalPipeline](#FrameStatsMetalPipeline) +- [FrameStatsMetalUniforms](#FrameStatsMetalUniforms) +- [FrameStatsWGPU](#FrameStatsWGPU) +- [FrameStatsWGPUBindings](#FrameStatsWGPUBindings) +- [FrameStatsWGPUUniforms](#FrameStatsWGPUUniforms) +- [GlSwapchain](#GlSwapchain) +- [Image](#Image) + - [free](#free) +- [ImageData](#ImageData) +- [ImageDesc](#ImageDesc) +- [ImageInfo](#ImageInfo) +- [Limits](#Limits) +- [MetalEnvironment](#MetalEnvironment) +- [MetalSwapchain](#MetalSwapchain) +- [Pass](#Pass) +- [PassAction](#PassAction) +- [Pipeline](#Pipeline) +- [PipelineDesc](#PipelineDesc) +- [PipelineInfo](#PipelineInfo) +- [PixelFormatInfo](#PixelFormatInfo) +- [Range](#Range) +- [Sampler](#Sampler) +- [SamplerDesc](#SamplerDesc) +- [Shader](#Shader) + - [free](#free) +- [ShaderAttrDesc](#ShaderAttrDesc) +- [ShaderDesc](#ShaderDesc) + - [make_shader](#make_shader) +- [ShaderImageDesc](#ShaderImageDesc) +- [ShaderImageSamplerPairDesc](#ShaderImageSamplerPairDesc) +- [ShaderInfo](#ShaderInfo) +- [ShaderSamplerDesc](#ShaderSamplerDesc) +- [ShaderStageDesc](#ShaderStageDesc) + - [set_image](#set_image) +- [ShaderStorageBufferDesc](#ShaderStorageBufferDesc) +- [ShaderUniformBlockDesc](#ShaderUniformBlockDesc) +- [ShaderUniformDesc](#ShaderUniformDesc) +- [SlotInfo](#SlotInfo) +- [StageBindings](#StageBindings) +- [StencilAttachmentAction](#StencilAttachmentAction) +- [StencilFaceState](#StencilFaceState) +- [StencilState](#StencilState) +- [Swapchain](#Swapchain) +- [VertexAttrDesc](#VertexAttrDesc) +- [VertexBufferLayoutState](#VertexBufferLayoutState) +- [VertexLayoutState](#VertexLayoutState) +- [WgpuEnvironment](#WgpuEnvironment) +- [WgpuSwapchain](#WgpuSwapchain) +- [Backend](#Backend) +- [BlendFactor](#BlendFactor) +- [BlendOp](#BlendOp) +- [BorderColor](#BorderColor) +- [BufferType](#BufferType) +- [ColorMask](#ColorMask) +- [CompareFunc](#CompareFunc) +- [CubeFace](#CubeFace) +- [CullMode](#CullMode) +- [FaceWinding](#FaceWinding) +- [Filter](#Filter) +- [ImageSampleType](#ImageSampleType) +- [ImageType](#ImageType) +- [IndexType](#IndexType) +- [LoadAction](#LoadAction) +- [PixelFormat](#PixelFormat) +- [PrimitiveType](#PrimitiveType) +- [ResourceState](#ResourceState) +- [SamplerType](#SamplerType) +- [ShaderStage](#ShaderStage) +- [StencilOp](#StencilOp) +- [StoreAction](#StoreAction) +- [UniformLayout](#UniformLayout) +- [UniformType](#UniformType) +- [Usage](#Usage) +- [VertexFormat](#VertexFormat) +- [VertexStep](#VertexStep) +- [Wrap](#Wrap) +- [C.sg_allocator](#C.sg_allocator) +- [C.sg_attachment_desc](#C.sg_attachment_desc) +- [C.sg_attachments](#C.sg_attachments) + - [free](#free) +- [C.sg_attachments_desc](#C.sg_attachments_desc) +- [C.sg_attachments_info](#C.sg_attachments_info) +- [C.sg_bindings](#C.sg_bindings) +- [C.sg_blend_state](#C.sg_blend_state) +- [C.sg_buffer](#C.sg_buffer) +- [C.sg_buffer_desc](#C.sg_buffer_desc) +- [C.sg_buffer_info](#C.sg_buffer_info) +- [C.sg_color](#C.sg_color) +- [C.sg_color_attachment_action](#C.sg_color_attachment_action) +- [C.sg_color_target_state](#C.sg_color_target_state) +- [C.sg_commit_listener](#C.sg_commit_listener) +- [C.sg_d3d11_environment](#C.sg_d3d11_environment) +- [C.sg_d3d11_swapchain](#C.sg_d3d11_swapchain) +- [C.sg_depth_attachment_action](#C.sg_depth_attachment_action) +- [C.sg_depth_state](#C.sg_depth_state) +- [C.sg_desc](#C.sg_desc) +- [C.sg_environment](#C.sg_environment) +- [C.sg_environment_defaults](#C.sg_environment_defaults) +- [C.sg_features](#C.sg_features) +- [C.sg_frame_stats](#C.sg_frame_stats) +- [C.sg_frame_stats_d3d11](#C.sg_frame_stats_d3d11) +- [C.sg_frame_stats_d3d11_bindings](#C.sg_frame_stats_d3d11_bindings) +- [C.sg_frame_stats_d3d11_draw](#C.sg_frame_stats_d3d11_draw) +- [C.sg_frame_stats_d3d11_pass](#C.sg_frame_stats_d3d11_pass) +- [C.sg_frame_stats_d3d11_pipeline](#C.sg_frame_stats_d3d11_pipeline) +- [C.sg_frame_stats_d3d11_uniforms](#C.sg_frame_stats_d3d11_uniforms) +- [C.sg_frame_stats_gl](#C.sg_frame_stats_gl) +- [C.sg_frame_stats_metal](#C.sg_frame_stats_metal) +- [C.sg_frame_stats_metal_bindings](#C.sg_frame_stats_metal_bindings) +- [C.sg_frame_stats_metal_idpool](#C.sg_frame_stats_metal_idpool) +- [C.sg_frame_stats_metal_pipeline](#C.sg_frame_stats_metal_pipeline) +- [C.sg_frame_stats_metal_uniforms](#C.sg_frame_stats_metal_uniforms) +- [C.sg_frame_stats_wgpu](#C.sg_frame_stats_wgpu) +- [C.sg_frame_stats_wgpu_bindings](#C.sg_frame_stats_wgpu_bindings) +- [C.sg_frame_stats_wgpu_uniforms](#C.sg_frame_stats_wgpu_uniforms) +- [C.sg_gl_swapchain](#C.sg_gl_swapchain) +- [C.sg_image](#C.sg_image) +- [C.sg_image_data](#C.sg_image_data) +- [C.sg_image_desc](#C.sg_image_desc) +- [C.sg_image_info](#C.sg_image_info) +- [C.sg_limits](#C.sg_limits) +- [C.sg_logger](#C.sg_logger) +- [C.sg_metal_environment](#C.sg_metal_environment) +- [C.sg_metal_swapchain](#C.sg_metal_swapchain) +- [C.sg_pass](#C.sg_pass) +- [C.sg_pass_action](#C.sg_pass_action) +- [C.sg_pipeline](#C.sg_pipeline) + - [free](#free) +- [C.sg_pipeline_desc](#C.sg_pipeline_desc) +- [C.sg_pipeline_info](#C.sg_pipeline_info) +- [C.sg_pixelformat_info](#C.sg_pixelformat_info) +- [C.sg_range](#C.sg_range) +- [C.sg_sampler](#C.sg_sampler) +- [C.sg_sampler_desc](#C.sg_sampler_desc) +- [C.sg_sampler_info](#C.sg_sampler_info) +- [C.sg_shader](#C.sg_shader) +- [C.sg_shader_attr_desc](#C.sg_shader_attr_desc) +- [C.sg_shader_desc](#C.sg_shader_desc) + - [set_vert_src](#set_vert_src) + - [set_frag_src](#set_frag_src) + - [set_vert_image](#set_vert_image) + - [set_frag_image](#set_frag_image) + - [set_vert_uniform_block_size](#set_vert_uniform_block_size) + - [set_frag_uniform_block_size](#set_frag_uniform_block_size) + - [set_vert_uniform](#set_vert_uniform) + - [set_frag_uniform](#set_frag_uniform) +- [C.sg_shader_image_desc](#C.sg_shader_image_desc) +- [C.sg_shader_image_sampler_pair_desc](#C.sg_shader_image_sampler_pair_desc) +- [C.sg_shader_info](#C.sg_shader_info) +- [C.sg_shader_sampler_desc](#C.sg_shader_sampler_desc) +- [C.sg_shader_stage_desc](#C.sg_shader_stage_desc) +- [C.sg_shader_storage_buffer_desc](#C.sg_shader_storage_buffer_desc) +- [C.sg_shader_uniform_block_desc](#C.sg_shader_uniform_block_desc) +- [C.sg_shader_uniform_desc](#C.sg_shader_uniform_desc) +- [C.sg_slot_info](#C.sg_slot_info) +- [C.sg_stage_bindings](#C.sg_stage_bindings) +- [C.sg_stencil_attachment_action](#C.sg_stencil_attachment_action) +- [C.sg_stencil_face_state](#C.sg_stencil_face_state) +- [C.sg_stencil_state](#C.sg_stencil_state) +- [C.sg_swapchain](#C.sg_swapchain) +- [C.sg_trace_hooks](#C.sg_trace_hooks) +- [C.sg_vertex_attr_state](#C.sg_vertex_attr_state) +- [C.sg_vertex_buffer_layout_state](#C.sg_vertex_buffer_layout_state) +- [C.sg_vertex_layout_state](#C.sg_vertex_layout_state) +- [C.sg_wgpu_environment](#C.sg_wgpu_environment) +- [C.sg_wgpu_swapchain](#C.sg_wgpu_swapchain) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## append_buffer +[[Return to contents]](#Contents) + +## apply_bindings +[[Return to contents]](#Contents) + +## apply_pipeline +[[Return to contents]](#Contents) + +## apply_scissor_rect +[[Return to contents]](#Contents) + +## apply_uniforms +[[Return to contents]](#Contents) + +## apply_viewport +[[Return to contents]](#Contents) + +## begin_pass +[[Return to contents]](#Contents) + +## commit +[[Return to contents]](#Contents) + +## create_clear_pass_action +[[Return to contents]](#Contents) + +## destroy_attachments +[[Return to contents]](#Contents) + +## destroy_buffer +[[Return to contents]](#Contents) + +## destroy_image +[[Return to contents]](#Contents) + +## destroy_pipeline +[[Return to contents]](#Contents) + +## destroy_sampler +[[Return to contents]](#Contents) + +## destroy_shader +[[Return to contents]](#Contents) + +## disable_frame_stats +[[Return to contents]](#Contents) + +## draw +[[Return to contents]](#Contents) + +## enable_frame_stats +[[Return to contents]](#Contents) + +## end_pass +[[Return to contents]](#Contents) + +## frame_stats_enabled +[[Return to contents]](#Contents) + +## is_valid +[[Return to contents]](#Contents) + +## make_attachments +[[Return to contents]](#Contents) + +## make_buffer +[[Return to contents]](#Contents) + +## make_image +[[Return to contents]](#Contents) + +## make_pipeline +[[Return to contents]](#Contents) + +## make_sampler +[[Return to contents]](#Contents) + +## make_shader +[[Return to contents]](#Contents) + +## query_attachments_defaults +[[Return to contents]](#Contents) + +## query_attachments_info +[[Return to contents]](#Contents) + +## query_attachments_state +[[Return to contents]](#Contents) + +## query_backend +[[Return to contents]](#Contents) + +## query_buffer_defaults +[[Return to contents]](#Contents) + +## query_buffer_info +[[Return to contents]](#Contents) + +## query_buffer_overflow +[[Return to contents]](#Contents) + +## query_buffer_state +[[Return to contents]](#Contents) + +## query_desc +[[Return to contents]](#Contents) + +## query_features +[[Return to contents]](#Contents) + +## query_frame_stats +[[Return to contents]](#Contents) + +## query_image_defaults +[[Return to contents]](#Contents) + +## query_image_info +[[Return to contents]](#Contents) + +## query_image_state +[[Return to contents]](#Contents) + +## query_limits +[[Return to contents]](#Contents) + +## query_pipeline_defaults +[[Return to contents]](#Contents) + +## query_pipeline_info +[[Return to contents]](#Contents) + +## query_pipeline_state +[[Return to contents]](#Contents) + +## query_pixelformat +[[Return to contents]](#Contents) + +## query_shader_defaults +[[Return to contents]](#Contents) + +## query_shader_info +[[Return to contents]](#Contents) + +## query_shader_state +[[Return to contents]](#Contents) + +## reset_state_cache +[[Return to contents]](#Contents) + +## setup +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## update_buffer +[[Return to contents]](#Contents) + +## update_image +[[Return to contents]](#Contents) + +## AttachmentDesc +[[Return to contents]](#Contents) + +## Attachments +[[Return to contents]](#Contents) + +## AttachmentsDesc +[[Return to contents]](#Contents) + +## AttachmentsInfo +[[Return to contents]](#Contents) + +## Bindings +[[Return to contents]](#Contents) + +## set_vert_image +[[Return to contents]](#Contents) + +## set_frag_image +[[Return to contents]](#Contents) + +## update_vert_buffer +[[Return to contents]](#Contents) + +## append_vert_buffer +[[Return to contents]](#Contents) + +## update_index_buffer +[[Return to contents]](#Contents) + +## append_index_buffer +[[Return to contents]](#Contents) + +## BlendState +[[Return to contents]](#Contents) + +## Buffer +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## BufferDesc +[[Return to contents]](#Contents) + +## BufferInfo +[[Return to contents]](#Contents) + +## Color +[[Return to contents]](#Contents) + +## ColorAttachmentAction +[[Return to contents]](#Contents) + +## ColorTargetState +[[Return to contents]](#Contents) + +## CommitListener +[[Return to contents]](#Contents) + +## D3d11Environment +[[Return to contents]](#Contents) + +## D3d11Swapchain +[[Return to contents]](#Contents) + +## DepthAttachmentAction +[[Return to contents]](#Contents) + +## DepthState +[[Return to contents]](#Contents) + +## Desc +[[Return to contents]](#Contents) + +## Environment +[[Return to contents]](#Contents) + +## EnvironmentDefaults +[[Return to contents]](#Contents) + +## Features +[[Return to contents]](#Contents) + +## FrameStats +[[Return to contents]](#Contents) + +## FrameStatsD3D11 +[[Return to contents]](#Contents) + +## FrameStatsD3D11Bindings +[[Return to contents]](#Contents) + +## FrameStatsD3D11Draw +[[Return to contents]](#Contents) + +## FrameStatsD3D11Pass +[[Return to contents]](#Contents) + +## FrameStatsD3D11Pipeline +[[Return to contents]](#Contents) + +## FrameStatsD3D11Uniforms +[[Return to contents]](#Contents) + +## FrameStatsGL +[[Return to contents]](#Contents) + +## FrameStatsMetal +[[Return to contents]](#Contents) + +## FrameStatsMetalBindings +[[Return to contents]](#Contents) + +## FrameStatsMetalIdpool +[[Return to contents]](#Contents) + +## FrameStatsMetalPipeline +[[Return to contents]](#Contents) + +## FrameStatsMetalUniforms +[[Return to contents]](#Contents) + +## FrameStatsWGPU +[[Return to contents]](#Contents) + +## FrameStatsWGPUBindings +[[Return to contents]](#Contents) + +## FrameStatsWGPUUniforms +[[Return to contents]](#Contents) + +## GlSwapchain +[[Return to contents]](#Contents) + +## Image +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## ImageData +[[Return to contents]](#Contents) + +## ImageDesc +[[Return to contents]](#Contents) + +## ImageInfo +[[Return to contents]](#Contents) + +## Limits +[[Return to contents]](#Contents) + +## MetalEnvironment +[[Return to contents]](#Contents) + +## MetalSwapchain +[[Return to contents]](#Contents) + +## Pass +[[Return to contents]](#Contents) + +## PassAction +[[Return to contents]](#Contents) + +## Pipeline +[[Return to contents]](#Contents) + +## PipelineDesc +[[Return to contents]](#Contents) + +## PipelineInfo +[[Return to contents]](#Contents) + +## PixelFormatInfo +[[Return to contents]](#Contents) + +## Range +[[Return to contents]](#Contents) + +## Sampler +[[Return to contents]](#Contents) + +## SamplerDesc +[[Return to contents]](#Contents) + +## Shader +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## ShaderAttrDesc +[[Return to contents]](#Contents) + +## ShaderDesc +[[Return to contents]](#Contents) + +## make_shader +[[Return to contents]](#Contents) + +## ShaderImageDesc +[[Return to contents]](#Contents) + +## ShaderImageSamplerPairDesc +[[Return to contents]](#Contents) + +## ShaderInfo +[[Return to contents]](#Contents) + +## ShaderSamplerDesc +[[Return to contents]](#Contents) + +## ShaderStageDesc +[[Return to contents]](#Contents) + +## set_image +[[Return to contents]](#Contents) + +## ShaderStorageBufferDesc +[[Return to contents]](#Contents) + +## ShaderUniformBlockDesc +[[Return to contents]](#Contents) + +## ShaderUniformDesc +[[Return to contents]](#Contents) + +## SlotInfo +[[Return to contents]](#Contents) + +## StageBindings +[[Return to contents]](#Contents) + +## StencilAttachmentAction +[[Return to contents]](#Contents) + +## StencilFaceState +[[Return to contents]](#Contents) + +## StencilState +[[Return to contents]](#Contents) + +## Swapchain +[[Return to contents]](#Contents) + +## VertexAttrDesc +[[Return to contents]](#Contents) + +## VertexBufferLayoutState +[[Return to contents]](#Contents) + +## VertexLayoutState +[[Return to contents]](#Contents) + +## WgpuEnvironment +[[Return to contents]](#Contents) + +## WgpuSwapchain +[[Return to contents]](#Contents) + +## Backend +[[Return to contents]](#Contents) + +## BlendFactor +[[Return to contents]](#Contents) + +## BlendOp +[[Return to contents]](#Contents) + +## BorderColor +[[Return to contents]](#Contents) + +## BufferType +[[Return to contents]](#Contents) + +## ColorMask +[[Return to contents]](#Contents) + +## CompareFunc +[[Return to contents]](#Contents) + +## CubeFace +[[Return to contents]](#Contents) + +## CullMode +[[Return to contents]](#Contents) + +## FaceWinding +[[Return to contents]](#Contents) + +## Filter +[[Return to contents]](#Contents) + +## ImageSampleType +[[Return to contents]](#Contents) + +## ImageType +[[Return to contents]](#Contents) + +## IndexType +[[Return to contents]](#Contents) + +## LoadAction +[[Return to contents]](#Contents) + +## PixelFormat +[[Return to contents]](#Contents) + +## PrimitiveType +[[Return to contents]](#Contents) + +## ResourceState +[[Return to contents]](#Contents) + +## SamplerType +[[Return to contents]](#Contents) + +## ShaderStage +[[Return to contents]](#Contents) + +## StencilOp +[[Return to contents]](#Contents) + +## StoreAction +[[Return to contents]](#Contents) + +## UniformLayout +[[Return to contents]](#Contents) + +## UniformType +[[Return to contents]](#Contents) + +## Usage +[[Return to contents]](#Contents) + +## VertexFormat +[[Return to contents]](#Contents) + +## VertexStep +[[Return to contents]](#Contents) + +## Wrap +[[Return to contents]](#Contents) + +## C.sg_allocator +[[Return to contents]](#Contents) + +## C.sg_attachment_desc +[[Return to contents]](#Contents) + +## C.sg_attachments +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## C.sg_attachments_desc +[[Return to contents]](#Contents) + +## C.sg_attachments_info +[[Return to contents]](#Contents) + +## C.sg_bindings +[[Return to contents]](#Contents) + +## C.sg_blend_state +[[Return to contents]](#Contents) + +## C.sg_buffer +[[Return to contents]](#Contents) + +## C.sg_buffer_desc +[[Return to contents]](#Contents) + +## C.sg_buffer_info +[[Return to contents]](#Contents) + +## C.sg_color +[[Return to contents]](#Contents) + +## C.sg_color_attachment_action +[[Return to contents]](#Contents) + +## C.sg_color_target_state +[[Return to contents]](#Contents) + +## C.sg_commit_listener +[[Return to contents]](#Contents) + +## C.sg_d3d11_environment +[[Return to contents]](#Contents) + +## C.sg_d3d11_swapchain +[[Return to contents]](#Contents) + +## C.sg_depth_attachment_action +[[Return to contents]](#Contents) + +## C.sg_depth_state +[[Return to contents]](#Contents) + +## C.sg_desc +[[Return to contents]](#Contents) + +## C.sg_environment +[[Return to contents]](#Contents) + +## C.sg_environment_defaults +[[Return to contents]](#Contents) + +## C.sg_features +[[Return to contents]](#Contents) + +## C.sg_frame_stats +[[Return to contents]](#Contents) + +## C.sg_frame_stats_d3d11 +[[Return to contents]](#Contents) + +## C.sg_frame_stats_d3d11_bindings +[[Return to contents]](#Contents) + +## C.sg_frame_stats_d3d11_draw +[[Return to contents]](#Contents) + +## C.sg_frame_stats_d3d11_pass +[[Return to contents]](#Contents) + +## C.sg_frame_stats_d3d11_pipeline +[[Return to contents]](#Contents) + +## C.sg_frame_stats_d3d11_uniforms +[[Return to contents]](#Contents) + +## C.sg_frame_stats_gl +[[Return to contents]](#Contents) + +## C.sg_frame_stats_metal +[[Return to contents]](#Contents) + +## C.sg_frame_stats_metal_bindings +[[Return to contents]](#Contents) + +## C.sg_frame_stats_metal_idpool +[[Return to contents]](#Contents) + +## C.sg_frame_stats_metal_pipeline +[[Return to contents]](#Contents) + +## C.sg_frame_stats_metal_uniforms +[[Return to contents]](#Contents) + +## C.sg_frame_stats_wgpu +[[Return to contents]](#Contents) + +## C.sg_frame_stats_wgpu_bindings +[[Return to contents]](#Contents) + +## C.sg_frame_stats_wgpu_uniforms +[[Return to contents]](#Contents) + +## C.sg_gl_swapchain +[[Return to contents]](#Contents) + +## C.sg_image +[[Return to contents]](#Contents) + +## C.sg_image_data +[[Return to contents]](#Contents) + +## C.sg_image_desc +[[Return to contents]](#Contents) + +## C.sg_image_info +[[Return to contents]](#Contents) + +## C.sg_limits +[[Return to contents]](#Contents) + +## C.sg_logger +[[Return to contents]](#Contents) + +## C.sg_metal_environment +[[Return to contents]](#Contents) + +## C.sg_metal_swapchain +[[Return to contents]](#Contents) + +## C.sg_pass +[[Return to contents]](#Contents) + +## C.sg_pass_action +[[Return to contents]](#Contents) + +## C.sg_pipeline +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## C.sg_pipeline_desc +[[Return to contents]](#Contents) + +## C.sg_pipeline_info +[[Return to contents]](#Contents) + +## C.sg_pixelformat_info +[[Return to contents]](#Contents) + +## C.sg_range +[[Return to contents]](#Contents) + +## C.sg_sampler +[[Return to contents]](#Contents) + +## C.sg_sampler_desc +[[Return to contents]](#Contents) + +## C.sg_sampler_info +[[Return to contents]](#Contents) + +## C.sg_shader +[[Return to contents]](#Contents) + +## C.sg_shader_attr_desc +[[Return to contents]](#Contents) + +## C.sg_shader_desc +[[Return to contents]](#Contents) + +## set_vert_src +[[Return to contents]](#Contents) + +## set_frag_src +[[Return to contents]](#Contents) + +## set_vert_image +[[Return to contents]](#Contents) + +## set_frag_image +[[Return to contents]](#Contents) + +## set_vert_uniform_block_size +[[Return to contents]](#Contents) + +## set_frag_uniform_block_size +[[Return to contents]](#Contents) + +## set_vert_uniform +[[Return to contents]](#Contents) + +## set_frag_uniform +[[Return to contents]](#Contents) + +## C.sg_shader_image_desc +[[Return to contents]](#Contents) + +## C.sg_shader_image_sampler_pair_desc +[[Return to contents]](#Contents) + +## C.sg_shader_info +[[Return to contents]](#Contents) + +## C.sg_shader_sampler_desc +[[Return to contents]](#Contents) + +## C.sg_shader_stage_desc +[[Return to contents]](#Contents) + +## C.sg_shader_storage_buffer_desc +[[Return to contents]](#Contents) + +## C.sg_shader_uniform_block_desc +[[Return to contents]](#Contents) + +## C.sg_shader_uniform_desc +[[Return to contents]](#Contents) + +## C.sg_slot_info +[[Return to contents]](#Contents) + +## C.sg_stage_bindings +[[Return to contents]](#Contents) + +## C.sg_stencil_attachment_action +[[Return to contents]](#Contents) + +## C.sg_stencil_face_state +[[Return to contents]](#Contents) + +## C.sg_stencil_state +[[Return to contents]](#Contents) + +## C.sg_swapchain +[[Return to contents]](#Contents) + +## C.sg_trace_hooks +[[Return to contents]](#Contents) + +## C.sg_vertex_attr_state +[[Return to contents]](#Contents) + +## C.sg_vertex_buffer_layout_state +[[Return to contents]](#Contents) + +## C.sg_vertex_layout_state +[[Return to contents]](#Contents) + +## C.sg_wgpu_environment +[[Return to contents]](#Contents) + +## C.sg_wgpu_swapchain +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sokol.memory.md b/vdocs/sokol.memory.md new file mode 100644 index 00000000..e4491006 --- /dev/null +++ b/vdocs/sokol.memory.md @@ -0,0 +1,30 @@ +# module sokol.memory + + +## Contents +- [salloc](#salloc) +- [sfree](#sfree) +- [slog](#slog) +- [FnAllocatorAlloc](#FnAllocatorAlloc) +- [FnAllocatorFree](#FnAllocatorFree) +- [FnLogCb](#FnLogCb) + +## salloc +[[Return to contents]](#Contents) + +## sfree +[[Return to contents]](#Contents) + +## slog +[[Return to contents]](#Contents) + +## FnAllocatorAlloc +[[Return to contents]](#Contents) + +## FnAllocatorFree +[[Return to contents]](#Contents) + +## FnLogCb +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sokol.sapp.md b/vdocs/sokol.sapp.md new file mode 100644 index 00000000..5e9922b6 --- /dev/null +++ b/vdocs/sokol.sapp.md @@ -0,0 +1,330 @@ +# module sokol.sapp + + +## Contents +- [android_get_native_activity](#android_get_native_activity) +- [cancel_quit](#cancel_quit) +- [color_format](#color_format) +- [consume_event](#consume_event) +- [create_default_pass](#create_default_pass) +- [create_desc](#create_desc) +- [d3d11_get_depth_stencil_view](#d3d11_get_depth_stencil_view) +- [d3d11_get_device](#d3d11_get_device) +- [d3d11_get_device_context](#d3d11_get_device_context) +- [d3d11_get_render_view](#d3d11_get_render_view) +- [d3d11_get_resolve_view](#d3d11_get_resolve_view) +- [depth_format](#depth_format) +- [dpi_scale](#dpi_scale) +- [frame_count](#frame_count) +- [frame_duration](#frame_duration) +- [get_clipboard_string](#get_clipboard_string) +- [get_dropped_file_path](#get_dropped_file_path) +- [get_num_dropped_files](#get_num_dropped_files) +- [gl_get_framebuffer](#gl_get_framebuffer) +- [glue_environment](#glue_environment) +- [glue_swapchain](#glue_swapchain) +- [height](#height) +- [high_dpi](#high_dpi) +- [html5_ask_leave_site](#html5_ask_leave_site) +- [ios_get_window](#ios_get_window) +- [is_fullscreen](#is_fullscreen) +- [isvalid](#isvalid) +- [keyboard_shown](#keyboard_shown) +- [lock_mouse](#lock_mouse) +- [macos_get_window](#macos_get_window) +- [metal_get_current_drawable](#metal_get_current_drawable) +- [metal_get_depth_stencil_texture](#metal_get_depth_stencil_texture) +- [metal_get_device](#metal_get_device) +- [metal_get_msaa_color_texture](#metal_get_msaa_color_texture) +- [mouse_locked](#mouse_locked) +- [mouse_shown](#mouse_shown) +- [query_desc](#query_desc) +- [quit](#quit) +- [request_quit](#request_quit) +- [run](#run) +- [sample_count](#sample_count) +- [screenshot](#screenshot) +- [screenshot_png](#screenshot_png) +- [screenshot_ppm](#screenshot_ppm) +- [screenshot_window](#screenshot_window) +- [set_clipboard_string](#set_clipboard_string) +- [set_mouse_cursor](#set_mouse_cursor) +- [show_keyboard](#show_keyboard) +- [show_mouse](#show_mouse) +- [toggle_fullscreen](#toggle_fullscreen) +- [userdata](#userdata) +- [wgpu_get_depth_stencil_view](#wgpu_get_depth_stencil_view) +- [wgpu_get_device](#wgpu_get_device) +- [wgpu_get_render_view](#wgpu_get_render_view) +- [wgpu_get_resolve_view](#wgpu_get_resolve_view) +- [width](#width) +- [win32_get_hwnd](#win32_get_hwnd) +- [Desc](#Desc) +- [Event](#Event) +- [IconDesc](#IconDesc) +- [ImageDesc](#ImageDesc) +- [Range](#Range) +- [TouchPoint](#TouchPoint) +- [EventType](#EventType) +- [KeyCode](#KeyCode) +- [Modifier](#Modifier) +- [MouseButton](#MouseButton) +- [MouseCursor](#MouseCursor) +- [TouchToolType](#TouchToolType) +- [C.sapp_allocator](#C.sapp_allocator) +- [C.sapp_desc](#C.sapp_desc) +- [C.sapp_event](#C.sapp_event) + - [str](#str) +- [C.sapp_icon_desc](#C.sapp_icon_desc) +- [C.sapp_image_desc](#C.sapp_image_desc) +- [C.sapp_logger](#C.sapp_logger) +- [C.sapp_range](#C.sapp_range) +- [C.sapp_touchpoint](#C.sapp_touchpoint) +- [Screenshot](#Screenshot) + - [free](#free) + - [destroy](#destroy) + +## android_get_native_activity +[[Return to contents]](#Contents) + +## cancel_quit +[[Return to contents]](#Contents) + +## color_format +[[Return to contents]](#Contents) + +## consume_event +[[Return to contents]](#Contents) + +## create_default_pass +[[Return to contents]](#Contents) + +## create_desc +[[Return to contents]](#Contents) + +## d3d11_get_depth_stencil_view +[[Return to contents]](#Contents) + +## d3d11_get_device +[[Return to contents]](#Contents) + +## d3d11_get_device_context +[[Return to contents]](#Contents) + +## d3d11_get_render_view +[[Return to contents]](#Contents) + +## d3d11_get_resolve_view +[[Return to contents]](#Contents) + +## depth_format +[[Return to contents]](#Contents) + +## dpi_scale +[[Return to contents]](#Contents) + +## frame_count +[[Return to contents]](#Contents) + +## frame_duration +[[Return to contents]](#Contents) + +## get_clipboard_string +[[Return to contents]](#Contents) + +## get_dropped_file_path +[[Return to contents]](#Contents) + +## get_num_dropped_files +[[Return to contents]](#Contents) + +## gl_get_framebuffer +[[Return to contents]](#Contents) + +## glue_environment +[[Return to contents]](#Contents) + +## glue_swapchain +[[Return to contents]](#Contents) + +## height +[[Return to contents]](#Contents) + +## high_dpi +[[Return to contents]](#Contents) + +## html5_ask_leave_site +[[Return to contents]](#Contents) + +## ios_get_window +[[Return to contents]](#Contents) + +## is_fullscreen +[[Return to contents]](#Contents) + +## isvalid +[[Return to contents]](#Contents) + +## keyboard_shown +[[Return to contents]](#Contents) + +## lock_mouse +[[Return to contents]](#Contents) + +## macos_get_window +[[Return to contents]](#Contents) + +## metal_get_current_drawable +[[Return to contents]](#Contents) + +## metal_get_depth_stencil_texture +[[Return to contents]](#Contents) + +## metal_get_device +[[Return to contents]](#Contents) + +## metal_get_msaa_color_texture +[[Return to contents]](#Contents) + +## mouse_locked +[[Return to contents]](#Contents) + +## mouse_shown +[[Return to contents]](#Contents) + +## query_desc +[[Return to contents]](#Contents) + +## quit +[[Return to contents]](#Contents) + +## request_quit +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## sample_count +[[Return to contents]](#Contents) + +## screenshot +[[Return to contents]](#Contents) + +## screenshot_png +[[Return to contents]](#Contents) + +## screenshot_ppm +[[Return to contents]](#Contents) + +## screenshot_window +[[Return to contents]](#Contents) + +## set_clipboard_string +[[Return to contents]](#Contents) + +## set_mouse_cursor +[[Return to contents]](#Contents) + +## show_keyboard +[[Return to contents]](#Contents) + +## show_mouse +[[Return to contents]](#Contents) + +## toggle_fullscreen +[[Return to contents]](#Contents) + +## userdata +[[Return to contents]](#Contents) + +## wgpu_get_depth_stencil_view +[[Return to contents]](#Contents) + +## wgpu_get_device +[[Return to contents]](#Contents) + +## wgpu_get_render_view +[[Return to contents]](#Contents) + +## wgpu_get_resolve_view +[[Return to contents]](#Contents) + +## width +[[Return to contents]](#Contents) + +## win32_get_hwnd +[[Return to contents]](#Contents) + +## Desc +[[Return to contents]](#Contents) + +## Event +[[Return to contents]](#Contents) + +## IconDesc +[[Return to contents]](#Contents) + +## ImageDesc +[[Return to contents]](#Contents) + +## Range +[[Return to contents]](#Contents) + +## TouchPoint +[[Return to contents]](#Contents) + +## EventType +[[Return to contents]](#Contents) + +## KeyCode +[[Return to contents]](#Contents) + +## Modifier +[[Return to contents]](#Contents) + +## MouseButton +[[Return to contents]](#Contents) + +## MouseCursor +[[Return to contents]](#Contents) + +## TouchToolType +[[Return to contents]](#Contents) + +## C.sapp_allocator +[[Return to contents]](#Contents) + +## C.sapp_desc +[[Return to contents]](#Contents) + +## C.sapp_event +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## C.sapp_icon_desc +[[Return to contents]](#Contents) + +## C.sapp_image_desc +[[Return to contents]](#Contents) + +## C.sapp_logger +[[Return to contents]](#Contents) + +## C.sapp_range +[[Return to contents]](#Contents) + +## C.sapp_touchpoint +[[Return to contents]](#Contents) + +## Screenshot +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sokol.sfons.md b/vdocs/sokol.sfons.md new file mode 100644 index 00000000..43756f8f --- /dev/null +++ b/vdocs/sokol.sfons.md @@ -0,0 +1,30 @@ +# module sokol.sfons + + +## Contents +- [create](#create) +- [destroy](#destroy) +- [flush](#flush) +- [rgba](#rgba) +- [C.sfons_allocator_t](#C.sfons_allocator_t) +- [C.sfons_desc_t](#C.sfons_desc_t) + +## create +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## flush +[[Return to contents]](#Contents) + +## rgba +[[Return to contents]](#Contents) + +## C.sfons_allocator_t +[[Return to contents]](#Contents) + +## C.sfons_desc_t +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sokol.sgl.md b/vdocs/sokol.sgl.md new file mode 100644 index 00000000..177f2f25 --- /dev/null +++ b/vdocs/sokol.sgl.md @@ -0,0 +1,388 @@ +# module sokol.sgl + + +## Contents +- [Constants](#Constants) +- [begin_line_strip](#begin_line_strip) +- [begin_lines](#begin_lines) +- [begin_points](#begin_points) +- [begin_quads](#begin_quads) +- [begin_triangle_strip](#begin_triangle_strip) +- [begin_triangles](#begin_triangles) +- [c1i](#c1i) +- [c3b](#c3b) +- [c3f](#c3f) +- [c4b](#c4b) +- [c4f](#c4f) +- [context_draw](#context_draw) +- [context_error](#context_error) +- [context_make_pipeline](#context_make_pipeline) +- [default_context](#default_context) +- [default_pipeline](#default_pipeline) +- [defaults](#defaults) +- [deg](#deg) +- [destroy_context](#destroy_context) +- [destroy_pipeline](#destroy_pipeline) +- [disable_texture](#disable_texture) +- [draw](#draw) +- [enable_texture](#enable_texture) +- [end](#end) +- [error](#error) +- [frustum](#frustum) +- [get_context](#get_context) +- [load_default_pipeline](#load_default_pipeline) +- [load_identity](#load_identity) +- [load_matrix](#load_matrix) +- [load_pipeline](#load_pipeline) +- [load_transpose_matrix](#load_transpose_matrix) +- [lookat](#lookat) +- [make_context](#make_context) +- [make_pipeline](#make_pipeline) +- [matrix_mode_modelview](#matrix_mode_modelview) +- [matrix_mode_projection](#matrix_mode_projection) +- [matrix_mode_texture](#matrix_mode_texture) +- [mult_matrix](#mult_matrix) +- [mult_transpose_matrix](#mult_transpose_matrix) +- [ortho](#ortho) +- [perspective](#perspective) +- [point_size](#point_size) +- [pop_matrix](#pop_matrix) +- [pop_pipeline](#pop_pipeline) +- [push_matrix](#push_matrix) +- [push_pipeline](#push_pipeline) +- [rad](#rad) +- [rotate](#rotate) +- [scale](#scale) +- [scissor_rect](#scissor_rect) +- [scissor_rectf](#scissor_rectf) +- [set_context](#set_context) +- [setup](#setup) +- [shutdown](#shutdown) +- [t2f](#t2f) +- [texture](#texture) +- [translate](#translate) +- [v2f](#v2f) +- [v2f_c1i](#v2f_c1i) +- [v2f_c3b](#v2f_c3b) +- [v2f_c3f](#v2f_c3f) +- [v2f_c4b](#v2f_c4b) +- [v2f_c4f](#v2f_c4f) +- [v2f_t2f](#v2f_t2f) +- [v2f_t2f_c1i](#v2f_t2f_c1i) +- [v2f_t2f_c3b](#v2f_t2f_c3b) +- [v2f_t2f_c3f](#v2f_t2f_c3f) +- [v2f_t2f_c4b](#v2f_t2f_c4b) +- [v2f_t2f_c4f](#v2f_t2f_c4f) +- [v3f](#v3f) +- [v3f_c1i](#v3f_c1i) +- [v3f_c3b](#v3f_c3b) +- [v3f_c3f](#v3f_c3f) +- [v3f_c4b](#v3f_c4b) +- [v3f_c4f](#v3f_c4f) +- [v3f_t2f](#v3f_t2f) +- [v3f_t2f_c1i](#v3f_t2f_c1i) +- [v3f_t2f_c3b](#v3f_t2f_c3b) +- [v3f_t2f_c3f](#v3f_t2f_c3f) +- [v3f_t2f_c4b](#v3f_t2f_c4b) +- [v3f_t2f_c4f](#v3f_t2f_c4f) +- [viewport](#viewport) +- [Context](#Context) +- [ContextDesc](#ContextDesc) +- [Desc](#Desc) +- [Pipeline](#Pipeline) +- [SglError](#SglError) +- [C.sgl_allocator_t](#C.sgl_allocator_t) +- [C.sgl_context](#C.sgl_context) +- [C.sgl_context_desc_t](#C.sgl_context_desc_t) +- [C.sgl_desc_t](#C.sgl_desc_t) +- [C.sgl_logger_t](#C.sgl_logger_t) +- [C.sgl_pipeline](#C.sgl_pipeline) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## begin_line_strip +[[Return to contents]](#Contents) + +## begin_lines +[[Return to contents]](#Contents) + +## begin_points +[[Return to contents]](#Contents) + +## begin_quads +[[Return to contents]](#Contents) + +## begin_triangle_strip +[[Return to contents]](#Contents) + +## begin_triangles +[[Return to contents]](#Contents) + +## c1i +[[Return to contents]](#Contents) + +## c3b +[[Return to contents]](#Contents) + +## c3f +[[Return to contents]](#Contents) + +## c4b +[[Return to contents]](#Contents) + +## c4f +[[Return to contents]](#Contents) + +## context_draw +[[Return to contents]](#Contents) + +## context_error +[[Return to contents]](#Contents) + +## context_make_pipeline +[[Return to contents]](#Contents) + +## default_context +[[Return to contents]](#Contents) + +## default_pipeline +[[Return to contents]](#Contents) + +## defaults +[[Return to contents]](#Contents) + +## deg +[[Return to contents]](#Contents) + +## destroy_context +[[Return to contents]](#Contents) + +## destroy_pipeline +[[Return to contents]](#Contents) + +## disable_texture +[[Return to contents]](#Contents) + +## draw +[[Return to contents]](#Contents) + +## enable_texture +[[Return to contents]](#Contents) + +## end +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## frustum +[[Return to contents]](#Contents) + +## get_context +[[Return to contents]](#Contents) + +## load_default_pipeline +[[Return to contents]](#Contents) + +## load_identity +[[Return to contents]](#Contents) + +## load_matrix +[[Return to contents]](#Contents) + +## load_pipeline +[[Return to contents]](#Contents) + +## load_transpose_matrix +[[Return to contents]](#Contents) + +## lookat +[[Return to contents]](#Contents) + +## make_context +[[Return to contents]](#Contents) + +## make_pipeline +[[Return to contents]](#Contents) + +## matrix_mode_modelview +[[Return to contents]](#Contents) + +## matrix_mode_projection +[[Return to contents]](#Contents) + +## matrix_mode_texture +[[Return to contents]](#Contents) + +## mult_matrix +[[Return to contents]](#Contents) + +## mult_transpose_matrix +[[Return to contents]](#Contents) + +## ortho +[[Return to contents]](#Contents) + +## perspective +[[Return to contents]](#Contents) + +## point_size +[[Return to contents]](#Contents) + +## pop_matrix +[[Return to contents]](#Contents) + +## pop_pipeline +[[Return to contents]](#Contents) + +## push_matrix +[[Return to contents]](#Contents) + +## push_pipeline +[[Return to contents]](#Contents) + +## rad +[[Return to contents]](#Contents) + +## rotate +[[Return to contents]](#Contents) + +## scale +[[Return to contents]](#Contents) + +## scissor_rect +[[Return to contents]](#Contents) + +## scissor_rectf +[[Return to contents]](#Contents) + +## set_context +[[Return to contents]](#Contents) + +## setup +[[Return to contents]](#Contents) + +## shutdown +[[Return to contents]](#Contents) + +## t2f +[[Return to contents]](#Contents) + +## texture +[[Return to contents]](#Contents) + +## translate +[[Return to contents]](#Contents) + +## v2f +[[Return to contents]](#Contents) + +## v2f_c1i +[[Return to contents]](#Contents) + +## v2f_c3b +[[Return to contents]](#Contents) + +## v2f_c3f +[[Return to contents]](#Contents) + +## v2f_c4b +[[Return to contents]](#Contents) + +## v2f_c4f +[[Return to contents]](#Contents) + +## v2f_t2f +[[Return to contents]](#Contents) + +## v2f_t2f_c1i +[[Return to contents]](#Contents) + +## v2f_t2f_c3b +[[Return to contents]](#Contents) + +## v2f_t2f_c3f +[[Return to contents]](#Contents) + +## v2f_t2f_c4b +[[Return to contents]](#Contents) + +## v2f_t2f_c4f +[[Return to contents]](#Contents) + +## v3f +[[Return to contents]](#Contents) + +## v3f_c1i +[[Return to contents]](#Contents) + +## v3f_c3b +[[Return to contents]](#Contents) + +## v3f_c3f +[[Return to contents]](#Contents) + +## v3f_c4b +[[Return to contents]](#Contents) + +## v3f_c4f +[[Return to contents]](#Contents) + +## v3f_t2f +[[Return to contents]](#Contents) + +## v3f_t2f_c1i +[[Return to contents]](#Contents) + +## v3f_t2f_c3b +[[Return to contents]](#Contents) + +## v3f_t2f_c3f +[[Return to contents]](#Contents) + +## v3f_t2f_c4b +[[Return to contents]](#Contents) + +## v3f_t2f_c4f +[[Return to contents]](#Contents) + +## viewport +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## ContextDesc +[[Return to contents]](#Contents) + +## Desc +[[Return to contents]](#Contents) + +## Pipeline +[[Return to contents]](#Contents) + +## SglError +[[Return to contents]](#Contents) + +## C.sgl_allocator_t +[[Return to contents]](#Contents) + +## C.sgl_context +[[Return to contents]](#Contents) + +## C.sgl_context_desc_t +[[Return to contents]](#Contents) + +## C.sgl_desc_t +[[Return to contents]](#Contents) + +## C.sgl_logger_t +[[Return to contents]](#Contents) + +## C.sgl_pipeline +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/stbi.md b/vdocs/stbi.md new file mode 100644 index 00000000..9f1249d4 --- /dev/null +++ b/vdocs/stbi.md @@ -0,0 +1,66 @@ +# module stbi + + +## Contents +- [load](#load) +- [load_from_memory](#load_from_memory) +- [resize_uint8](#resize_uint8) +- [set_flip_vertically_on_load](#set_flip_vertically_on_load) +- [set_flip_vertically_on_write](#set_flip_vertically_on_write) +- [set_png_compression_level](#set_png_compression_level) +- [stbi_write_bmp](#stbi_write_bmp) +- [stbi_write_jpg](#stbi_write_jpg) +- [stbi_write_png](#stbi_write_png) +- [stbi_write_tga](#stbi_write_tga) +- [write_force_png_filter](#write_force_png_filter) +- [write_tga_with_rle](#write_tga_with_rle) +- [Image](#Image) + - [free](#free) +- [LoadParams](#LoadParams) + +## load +[[Return to contents]](#Contents) + +## load_from_memory +[[Return to contents]](#Contents) + +## resize_uint8 +[[Return to contents]](#Contents) + +## set_flip_vertically_on_load +[[Return to contents]](#Contents) + +## set_flip_vertically_on_write +[[Return to contents]](#Contents) + +## set_png_compression_level +[[Return to contents]](#Contents) + +## stbi_write_bmp +[[Return to contents]](#Contents) + +## stbi_write_jpg +[[Return to contents]](#Contents) + +## stbi_write_png +[[Return to contents]](#Contents) + +## stbi_write_tga +[[Return to contents]](#Contents) + +## write_force_png_filter +[[Return to contents]](#Contents) + +## write_tga_with_rle +[[Return to contents]](#Contents) + +## Image +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## LoadParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/strconv.md b/vdocs/strconv.md new file mode 100644 index 00000000..301da2ec --- /dev/null +++ b/vdocs/strconv.md @@ -0,0 +1,290 @@ +# module strconv + + +## Contents +- [Constants](#Constants) +- [atof64](#atof64) +- [atof_quick](#atof_quick) +- [atoi](#atoi) +- [byte_to_lower](#byte_to_lower) +- [common_parse_int](#common_parse_int) +- [common_parse_uint](#common_parse_uint) +- [common_parse_uint2](#common_parse_uint2) +- [dec_digits](#dec_digits) +- [f32_to_str](#f32_to_str) +- [f32_to_str_l](#f32_to_str_l) +- [f32_to_str_l_with_dot](#f32_to_str_l_with_dot) +- [f32_to_str_pad](#f32_to_str_pad) +- [f64_to_str](#f64_to_str) +- [f64_to_str_l](#f64_to_str_l) +- [f64_to_str_l_with_dot](#f64_to_str_l_with_dot) +- [f64_to_str_lnd1](#f64_to_str_lnd1) +- [f64_to_str_pad](#f64_to_str_pad) +- [format_dec_old](#format_dec_old) +- [format_dec_sb](#format_dec_sb) +- [format_es](#format_es) +- [format_fl](#format_fl) +- [format_fl_old](#format_fl_old) +- [format_int](#format_int) +- [format_str](#format_str) +- [format_str_sb](#format_str_sb) +- [format_uint](#format_uint) +- [ftoa_32](#ftoa_32) +- [ftoa_64](#ftoa_64) +- [ftoa_long_32](#ftoa_long_32) +- [ftoa_long_64](#ftoa_long_64) +- [fxx_to_str_l_parse](#fxx_to_str_l_parse) +- [fxx_to_str_l_parse_with_dot](#fxx_to_str_l_parse_with_dot) +- [parse_int](#parse_int) +- [parse_uint](#parse_uint) +- [remove_tail_zeros](#remove_tail_zeros) +- [v_printf](#v_printf) +- [v_sprintf](#v_sprintf) +- [Dec32](#Dec32) + - [get_string_32](#get_string_32) +- [Align_text](#Align_text) +- [BF_param](#BF_param) +- [Float32u](#Float32u) +- [Float64u](#Float64u) +- [PrepNumber](#PrepNumber) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## atof64 +[[Return to contents]](#Contents) + +## atof_quick +[[Return to contents]](#Contents) + +## atoi +[[Return to contents]](#Contents) + +## byte_to_lower +[[Return to contents]](#Contents) + +## common_parse_int +[[Return to contents]](#Contents) + +## common_parse_uint +[[Return to contents]](#Contents) + +## common_parse_uint2 +[[Return to contents]](#Contents) + +## dec_digits +[[Return to contents]](#Contents) + +## f32_to_str +[[Return to contents]](#Contents) + +## f32_to_str_l +Example +```v + +assert strconv.f32_to_str_l(34.1234567) == '34.12346' + +``` + +[[Return to contents]](#Contents) + +## f32_to_str_l_with_dot +Example +```v + +assert strconv.f32_to_str_l_with_dot(34.) == '34.0' + +``` + +[[Return to contents]](#Contents) + +## f32_to_str_pad +[[Return to contents]](#Contents) + +## f64_to_str +[[Return to contents]](#Contents) + +## f64_to_str_l +Example +```v + +assert strconv.f64_to_str_l(123.1234567891011121) == '123.12345678910111' + +``` + +[[Return to contents]](#Contents) + +## f64_to_str_l_with_dot +Example +```v + +assert strconv.f64_to_str_l_with_dot (34.) == '34.0' + +``` + +[[Return to contents]](#Contents) + +## f64_to_str_lnd1 +[[Return to contents]](#Contents) + +## f64_to_str_pad +[[Return to contents]](#Contents) + +## format_dec_old +[[Return to contents]](#Contents) + +## format_dec_sb +[[Return to contents]](#Contents) + +## format_es +[[Return to contents]](#Contents) + +## format_fl +[[Return to contents]](#Contents) + +## format_fl_old +[[Return to contents]](#Contents) + +## format_int +[[Return to contents]](#Contents) + +## format_str +[[Return to contents]](#Contents) + +## format_str_sb +[[Return to contents]](#Contents) + +## format_uint +[[Return to contents]](#Contents) + +## ftoa_32 +Example +```v + +assert strconv.ftoa_32(34.1234567) == '3.4123455e+01' + +``` + +[[Return to contents]](#Contents) + +## ftoa_64 +Example +```v + +assert strconv.ftoa_64(123.1234567891011121) == '1.2312345678910111e+02' + +``` + +[[Return to contents]](#Contents) + +## ftoa_long_32 +Example +```v + +assert strconv.ftoa_long_32(34.1234567) == '34.12346' + +``` + +[[Return to contents]](#Contents) + +## ftoa_long_64 +Example +```v + +assert strconv.f64_to_str_l(123.1234567891011121) == '123.12345678910111' + +``` + +[[Return to contents]](#Contents) + +## fxx_to_str_l_parse +Example +```v + +assert strconv.fxx_to_str_l_parse('34.22e+00') == '34.22' + +``` + +[[Return to contents]](#Contents) + +## fxx_to_str_l_parse_with_dot +Example +```v + +assert strconv.fxx_to_str_l_parse_with_dot ('34.e+01') == '340.0' + +``` + +[[Return to contents]](#Contents) + +## parse_int +[[Return to contents]](#Contents) + +## parse_uint +[[Return to contents]](#Contents) + +## remove_tail_zeros +[[Return to contents]](#Contents) + +## v_printf +[[Return to contents]](#Contents) + +## v_sprintf +Example +```v + +x := 3.141516 +assert strconv.v_sprintf('aaa %G', x) == 'aaa 3.141516' + +``` + +[[Return to contents]](#Contents) + +## Dec32 +## get_string_32 +[[Return to contents]](#Contents) + +## Align_text +[[Return to contents]](#Contents) + +## BF_param +[[Return to contents]](#Contents) + +## Float32u +[[Return to contents]](#Contents) + +## Float64u +[[Return to contents]](#Contents) + +## PrepNumber +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/strings.md b/vdocs/strings.md new file mode 100644 index 00000000..af6cb696 --- /dev/null +++ b/vdocs/strings.md @@ -0,0 +1,206 @@ +# module strings + + +## Contents +- [dice_coefficient](#dice_coefficient) +- [find_between_pair_rune](#find_between_pair_rune) +- [find_between_pair_string](#find_between_pair_string) +- [find_between_pair_u8](#find_between_pair_u8) +- [hamming_distance](#hamming_distance) +- [hamming_similarity](#hamming_similarity) +- [jaro_similarity](#jaro_similarity) +- [jaro_winkler_similarity](#jaro_winkler_similarity) +- [levenshtein_distance](#levenshtein_distance) +- [levenshtein_distance_percentage](#levenshtein_distance_percentage) +- [new_builder](#new_builder) +- [repeat](#repeat) +- [repeat_string](#repeat_string) +- [split_capital](#split_capital) +- [Builder](#Builder) + - [reuse_as_plain_u8_array](#reuse_as_plain_u8_array) + - [write_ptr](#write_ptr) + - [write_rune](#write_rune) + - [write_runes](#write_runes) + - [clear](#clear) + - [write_u8](#write_u8) + - [write_byte](#write_byte) + - [write_decimal](#write_decimal) + - [write](#write) + - [drain_builder](#drain_builder) + - [byte_at](#byte_at) + - [write_string](#write_string) + - [write_string2](#write_string2) + - [go_back](#go_back) + - [spart](#spart) + - [cut_last](#cut_last) + - [cut_to](#cut_to) + - [go_back_to](#go_back_to) + - [writeln](#writeln) + - [writeln2](#writeln2) + - [last_n](#last_n) + - [after](#after) + - [str](#str) + - [ensure_cap](#ensure_cap) + - [grow_len](#grow_len) + - [free](#free) + +## dice_coefficient +[[Return to contents]](#Contents) + +## find_between_pair_rune +Examples +```v + +assert strings.find_between_pair_rune('(V) (NOT V)',`(`,`)`) == 'V' + +assert strings.find_between_pair_rune('s {X{Y}} s',`{`,`}`) == 'X{Y}' + +``` + +[[Return to contents]](#Contents) + +## find_between_pair_string +Examples +```v + +assert strings.find_between_pair_string('/*V*/ /*NOT V*/','/*','*/') == 'V' + +assert strings.find_between_pair_string('s {{X{{Y}}}} s','{{','}}') == 'X{{Y}}' + +``` + +[[Return to contents]](#Contents) + +## find_between_pair_u8 +Examples +```v + +assert strings.find_between_pair_u8('(V) (NOT V)',`(`,`)`) == 'V' + +assert strings.find_between_pair_u8('s {X{Y}} s',`{`,`}`) == 'X{Y}' + +``` + +[[Return to contents]](#Contents) + +## hamming_distance +[[Return to contents]](#Contents) + +## hamming_similarity +[[Return to contents]](#Contents) + +## jaro_similarity +[[Return to contents]](#Contents) + +## jaro_winkler_similarity +[[Return to contents]](#Contents) + +## levenshtein_distance +[[Return to contents]](#Contents) + +## levenshtein_distance_percentage +[[Return to contents]](#Contents) + +## new_builder +[[Return to contents]](#Contents) + +## repeat +[[Return to contents]](#Contents) + +## repeat_string +[[Return to contents]](#Contents) + +## split_capital +Examples +```v + +assert strings.split_capital('XYZ') == ['X', 'Y', 'Z'] + +assert strings.split_capital('XYStar') == ['X', 'Y', 'Star'] + +``` + +[[Return to contents]](#Contents) + +## Builder +[[Return to contents]](#Contents) + +## reuse_as_plain_u8_array +[[Return to contents]](#Contents) + +## write_ptr +[[Return to contents]](#Contents) + +## write_rune +[[Return to contents]](#Contents) + +## write_runes +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## write_u8 +[[Return to contents]](#Contents) + +## write_byte +[[Return to contents]](#Contents) + +## write_decimal +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## drain_builder +[[Return to contents]](#Contents) + +## byte_at +[[Return to contents]](#Contents) + +## write_string +[[Return to contents]](#Contents) + +## write_string2 +[[Return to contents]](#Contents) + +## go_back +[[Return to contents]](#Contents) + +## spart +[[Return to contents]](#Contents) + +## cut_last +[[Return to contents]](#Contents) + +## cut_to +[[Return to contents]](#Contents) + +## go_back_to +[[Return to contents]](#Contents) + +## writeln +[[Return to contents]](#Contents) + +## writeln2 +[[Return to contents]](#Contents) + +## last_n +[[Return to contents]](#Contents) + +## after +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ensure_cap +[[Return to contents]](#Contents) + +## grow_len +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/strings.textscanner.md b/vdocs/strings.textscanner.md new file mode 100644 index 00000000..f7fb3f60 --- /dev/null +++ b/vdocs/strings.textscanner.md @@ -0,0 +1,82 @@ +# module strings.textscanner + + +## Contents +- [new](#new) +- [TextScanner](#TextScanner) + - [free](#free) + - [remaining](#remaining) + - [next](#next) + - [skip](#skip) + - [skip_n](#skip_n) + - [peek](#peek) + - [peek_u8](#peek_u8) + - [peek_n](#peek_n) + - [peek_n_u8](#peek_n_u8) + - [back](#back) + - [back_n](#back_n) + - [peek_back](#peek_back) + - [peek_back_n](#peek_back_n) + - [current](#current) + - [reset](#reset) + - [goto_end](#goto_end) + - [skip_whitespace](#skip_whitespace) + +## new +[[Return to contents]](#Contents) + +## TextScanner +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## remaining +[[Return to contents]](#Contents) + +## next +[[Return to contents]](#Contents) + +## skip +[[Return to contents]](#Contents) + +## skip_n +[[Return to contents]](#Contents) + +## peek +[[Return to contents]](#Contents) + +## peek_u8 +[[Return to contents]](#Contents) + +## peek_n +[[Return to contents]](#Contents) + +## peek_n_u8 +[[Return to contents]](#Contents) + +## back +[[Return to contents]](#Contents) + +## back_n +[[Return to contents]](#Contents) + +## peek_back +[[Return to contents]](#Contents) + +## peek_back_n +[[Return to contents]](#Contents) + +## current +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## goto_end +[[Return to contents]](#Contents) + +## skip_whitespace +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sync.md b/vdocs/sync.md new file mode 100644 index 00000000..a17add30 --- /dev/null +++ b/vdocs/sync.md @@ -0,0 +1,250 @@ +# module sync + + +## Contents +- [channel_select](#channel_select) +- [new_channel](#new_channel) +- [new_many_times](#new_many_times) +- [new_mutex](#new_mutex) +- [new_once](#new_once) +- [new_rwmutex](#new_rwmutex) +- [new_semaphore](#new_semaphore) +- [new_semaphore_init](#new_semaphore_init) +- [new_waitgroup](#new_waitgroup) +- [thread_id](#thread_id) +- [Direction](#Direction) +- [C.atomic_uintptr_t](#C.atomic_uintptr_t) +- [C.pthread_cond_t](#C.pthread_cond_t) +- [C.pthread_condattr_t](#C.pthread_condattr_t) +- [C.pthread_mutex_t](#C.pthread_mutex_t) +- [C.pthread_rwlock_t](#C.pthread_rwlock_t) +- [C.pthread_rwlockattr_t](#C.pthread_rwlockattr_t) +- [C.sem_t](#C.sem_t) +- [Channel](#Channel) + - [auto_str](#auto_str) + - [close](#close) + - [len](#len) + - [closed](#closed) + - [push](#push) + - [try_push](#try_push) + - [pop](#pop) + - [try_pop](#try_pop) +- [ManyTimes](#ManyTimes) + - [do](#do) +- [Mutex](#Mutex) + - [destroy](#destroy) + - [init](#init) + - [lock](#lock) + - [str](#str) + - [try_lock](#try_lock) + - [unlock](#unlock) +- [Once](#Once) + - [do](#do) + - [do_with_param](#do_with_param) +- [RwMutex](#RwMutex) + - [destroy](#destroy) + - [init](#init) + - [lock](#lock) + - [rlock](#rlock) + - [runlock](#runlock) + - [str](#str) + - [try_rlock](#try_rlock) + - [try_wlock](#try_wlock) + - [unlock](#unlock) +- [Semaphore](#Semaphore) + - [init](#init) + - [post](#post) + - [wait](#wait) + - [try_wait](#try_wait) + - [timed_wait](#timed_wait) + - [destroy](#destroy) +- [WaitGroup](#WaitGroup) + - [init](#init) + - [add](#add) + - [done](#done) + - [wait](#wait) + +## channel_select +[[Return to contents]](#Contents) + +## new_channel +[[Return to contents]](#Contents) + +## new_many_times +[[Return to contents]](#Contents) + +## new_mutex +[[Return to contents]](#Contents) + +## new_once +[[Return to contents]](#Contents) + +## new_rwmutex +[[Return to contents]](#Contents) + +## new_semaphore +[[Return to contents]](#Contents) + +## new_semaphore_init +[[Return to contents]](#Contents) + +## new_waitgroup +[[Return to contents]](#Contents) + +## thread_id +[[Return to contents]](#Contents) + +## Direction +[[Return to contents]](#Contents) + +## C.atomic_uintptr_t +[[Return to contents]](#Contents) + +## C.pthread_cond_t +[[Return to contents]](#Contents) + +## C.pthread_condattr_t +[[Return to contents]](#Contents) + +## C.pthread_mutex_t +[[Return to contents]](#Contents) + +## C.pthread_rwlock_t +[[Return to contents]](#Contents) + +## C.pthread_rwlockattr_t +[[Return to contents]](#Contents) + +## C.sem_t +[[Return to contents]](#Contents) + +## Channel +[[Return to contents]](#Contents) + +## auto_str +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## len +[[Return to contents]](#Contents) + +## closed +[[Return to contents]](#Contents) + +## push +[[Return to contents]](#Contents) + +## try_push +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## try_pop +[[Return to contents]](#Contents) + +## ManyTimes +[[Return to contents]](#Contents) + +## do +[[Return to contents]](#Contents) + +## Mutex +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## lock +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## try_lock +[[Return to contents]](#Contents) + +## unlock +[[Return to contents]](#Contents) + +## Once +[[Return to contents]](#Contents) + +## do +[[Return to contents]](#Contents) + +## do_with_param +[[Return to contents]](#Contents) + +## RwMutex +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## lock +[[Return to contents]](#Contents) + +## rlock +[[Return to contents]](#Contents) + +## runlock +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## try_rlock +[[Return to contents]](#Contents) + +## try_wlock +[[Return to contents]](#Contents) + +## unlock +[[Return to contents]](#Contents) + +## Semaphore +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## post +[[Return to contents]](#Contents) + +## wait +[[Return to contents]](#Contents) + +## try_wait +[[Return to contents]](#Contents) + +## timed_wait +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## WaitGroup +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## done +[[Return to contents]](#Contents) + +## wait +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sync.pool.md b/vdocs/sync.pool.md new file mode 100644 index 00000000..f8bb6dd6 --- /dev/null +++ b/vdocs/sync.pool.md @@ -0,0 +1,70 @@ +# module sync.pool + + +## Contents +- [Constants](#Constants) +- [new_pool_processor](#new_pool_processor) +- [ThreadCB](#ThreadCB) +- [PoolProcessor](#PoolProcessor) + - [set_max_jobs](#set_max_jobs) + - [work_on_items](#work_on_items) + - [work_on_pointers](#work_on_pointers) + - [get_item](#get_item) + - [get_result](#get_result) + - [get_results](#get_results) + - [get_results_ref](#get_results_ref) + - [set_shared_context](#set_shared_context) + - [get_shared_context](#get_shared_context) + - [set_thread_context](#set_thread_context) + - [get_thread_context](#get_thread_context) +- [PoolProcessorConfig](#PoolProcessorConfig) + +## Constants +[[Return to contents]](#Contents) + +## new_pool_processor +[[Return to contents]](#Contents) + +## ThreadCB +[[Return to contents]](#Contents) + +## PoolProcessor +[[Return to contents]](#Contents) + +## set_max_jobs +[[Return to contents]](#Contents) + +## work_on_items +[[Return to contents]](#Contents) + +## work_on_pointers +[[Return to contents]](#Contents) + +## get_item +[[Return to contents]](#Contents) + +## get_result +[[Return to contents]](#Contents) + +## get_results +[[Return to contents]](#Contents) + +## get_results_ref +[[Return to contents]](#Contents) + +## set_shared_context +[[Return to contents]](#Contents) + +## get_shared_context +[[Return to contents]](#Contents) + +## set_thread_context +[[Return to contents]](#Contents) + +## get_thread_context +[[Return to contents]](#Contents) + +## PoolProcessorConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/sync.stdatomic.md b/vdocs/sync.stdatomic.md new file mode 100644 index 00000000..f58d449f --- /dev/null +++ b/vdocs/sync.stdatomic.md @@ -0,0 +1,38 @@ +# module sync.stdatomic + + +## Contents +- [add_i64](#add_i64) +- [add_u64](#add_u64) +- [load_i64](#load_i64) +- [load_u64](#load_u64) +- [store_i64](#store_i64) +- [store_u64](#store_u64) +- [sub_i64](#sub_i64) +- [sub_u64](#sub_u64) + +## add_i64 +[[Return to contents]](#Contents) + +## add_u64 +[[Return to contents]](#Contents) + +## load_i64 +[[Return to contents]](#Contents) + +## load_u64 +[[Return to contents]](#Contents) + +## store_i64 +[[Return to contents]](#Contents) + +## store_u64 +[[Return to contents]](#Contents) + +## sub_i64 +[[Return to contents]](#Contents) + +## sub_u64 +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/term.md b/vdocs/term.md new file mode 100644 index 00000000..08151143 --- /dev/null +++ b/vdocs/term.md @@ -0,0 +1,404 @@ +# module term + + +## Contents +- [bg_black](#bg_black) +- [bg_blue](#bg_blue) +- [bg_cyan](#bg_cyan) +- [bg_green](#bg_green) +- [bg_hex](#bg_hex) +- [bg_magenta](#bg_magenta) +- [bg_red](#bg_red) +- [bg_rgb](#bg_rgb) +- [bg_white](#bg_white) +- [bg_yellow](#bg_yellow) +- [black](#black) +- [blue](#blue) +- [bold](#bold) +- [bright_bg_black](#bright_bg_black) +- [bright_bg_blue](#bright_bg_blue) +- [bright_bg_cyan](#bright_bg_cyan) +- [bright_bg_green](#bright_bg_green) +- [bright_bg_magenta](#bright_bg_magenta) +- [bright_bg_red](#bright_bg_red) +- [bright_bg_white](#bright_bg_white) +- [bright_bg_yellow](#bright_bg_yellow) +- [bright_black](#bright_black) +- [bright_blue](#bright_blue) +- [bright_cyan](#bright_cyan) +- [bright_green](#bright_green) +- [bright_magenta](#bright_magenta) +- [bright_red](#bright_red) +- [bright_white](#bright_white) +- [bright_yellow](#bright_yellow) +- [can_show_color_on_stderr](#can_show_color_on_stderr) +- [can_show_color_on_stdout](#can_show_color_on_stdout) +- [clear](#clear) +- [clear_previous_line](#clear_previous_line) +- [colorize](#colorize) +- [cursor_back](#cursor_back) +- [cursor_down](#cursor_down) +- [cursor_forward](#cursor_forward) +- [cursor_up](#cursor_up) +- [cyan](#cyan) +- [dim](#dim) +- [ecolorize](#ecolorize) +- [enable_echo](#enable_echo) +- [erase_clear](#erase_clear) +- [erase_del_clear](#erase_del_clear) +- [erase_display](#erase_display) +- [erase_line](#erase_line) +- [erase_line_clear](#erase_line_clear) +- [erase_line_tobeg](#erase_line_tobeg) +- [erase_line_toend](#erase_line_toend) +- [erase_tobeg](#erase_tobeg) +- [erase_toend](#erase_toend) +- [fail_message](#fail_message) +- [failed](#failed) +- [format](#format) +- [format_esc](#format_esc) +- [format_rgb](#format_rgb) +- [get_cursor_position](#get_cursor_position) +- [get_terminal_size](#get_terminal_size) +- [graphics_num_colors](#graphics_num_colors) +- [gray](#gray) +- [green](#green) +- [h_divider](#h_divider) +- [header](#header) +- [header_left](#header_left) +- [hex](#hex) +- [hidden](#hidden) +- [hide_cursor](#hide_cursor) +- [highlight_command](#highlight_command) +- [inverse](#inverse) +- [italic](#italic) +- [key_pressed](#key_pressed) +- [magenta](#magenta) +- [move](#move) +- [ok_message](#ok_message) +- [rapid_blink](#rapid_blink) +- [red](#red) +- [reset](#reset) +- [rgb](#rgb) +- [set_cursor_position](#set_cursor_position) +- [set_tab_title](#set_tab_title) +- [set_terminal_title](#set_terminal_title) +- [show_cursor](#show_cursor) +- [slow_blink](#slow_blink) +- [strikethrough](#strikethrough) +- [strip_ansi](#strip_ansi) +- [supports_sixel](#supports_sixel) +- [underline](#underline) +- [utf8_getchar](#utf8_getchar) +- [utf8_len](#utf8_len) +- [warn_message](#warn_message) +- [white](#white) +- [yellow](#yellow) +- [C.termios](#C.termios) +- [C.winsize](#C.winsize) +- [Coord](#Coord) +- [KeyPressedParams](#KeyPressedParams) + +## bg_black +[[Return to contents]](#Contents) + +## bg_blue +[[Return to contents]](#Contents) + +## bg_cyan +[[Return to contents]](#Contents) + +## bg_green +[[Return to contents]](#Contents) + +## bg_hex +[[Return to contents]](#Contents) + +## bg_magenta +[[Return to contents]](#Contents) + +## bg_red +[[Return to contents]](#Contents) + +## bg_rgb +[[Return to contents]](#Contents) + +## bg_white +[[Return to contents]](#Contents) + +## bg_yellow +[[Return to contents]](#Contents) + +## black +[[Return to contents]](#Contents) + +## blue +[[Return to contents]](#Contents) + +## bold +[[Return to contents]](#Contents) + +## bright_bg_black +[[Return to contents]](#Contents) + +## bright_bg_blue +[[Return to contents]](#Contents) + +## bright_bg_cyan +[[Return to contents]](#Contents) + +## bright_bg_green +[[Return to contents]](#Contents) + +## bright_bg_magenta +[[Return to contents]](#Contents) + +## bright_bg_red +[[Return to contents]](#Contents) + +## bright_bg_white +[[Return to contents]](#Contents) + +## bright_bg_yellow +[[Return to contents]](#Contents) + +## bright_black +[[Return to contents]](#Contents) + +## bright_blue +[[Return to contents]](#Contents) + +## bright_cyan +[[Return to contents]](#Contents) + +## bright_green +[[Return to contents]](#Contents) + +## bright_magenta +[[Return to contents]](#Contents) + +## bright_red +[[Return to contents]](#Contents) + +## bright_white +[[Return to contents]](#Contents) + +## bright_yellow +[[Return to contents]](#Contents) + +## can_show_color_on_stderr +[[Return to contents]](#Contents) + +## can_show_color_on_stdout +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## clear_previous_line +[[Return to contents]](#Contents) + +## colorize +Example +```v + +term.colorize(term.yellow, 'the message') + +``` + +[[Return to contents]](#Contents) + +## cursor_back +[[Return to contents]](#Contents) + +## cursor_down +[[Return to contents]](#Contents) + +## cursor_forward +[[Return to contents]](#Contents) + +## cursor_up +[[Return to contents]](#Contents) + +## cyan +[[Return to contents]](#Contents) + +## dim +[[Return to contents]](#Contents) + +## ecolorize +Example +```v + +term.ecolorize(term.bright_red, 'the message') + +``` + +[[Return to contents]](#Contents) + +## enable_echo +[[Return to contents]](#Contents) + +## erase_clear +[[Return to contents]](#Contents) + +## erase_del_clear +[[Return to contents]](#Contents) + +## erase_display +[[Return to contents]](#Contents) + +## erase_line +[[Return to contents]](#Contents) + +## erase_line_clear +[[Return to contents]](#Contents) + +## erase_line_tobeg +[[Return to contents]](#Contents) + +## erase_line_toend +[[Return to contents]](#Contents) + +## erase_tobeg +[[Return to contents]](#Contents) + +## erase_toend +[[Return to contents]](#Contents) + +## fail_message +[[Return to contents]](#Contents) + +## failed +[[Return to contents]](#Contents) + +## format +[[Return to contents]](#Contents) + +## format_esc +[[Return to contents]](#Contents) + +## format_rgb +[[Return to contents]](#Contents) + +## get_cursor_position +[[Return to contents]](#Contents) + +## get_terminal_size +[[Return to contents]](#Contents) + +## graphics_num_colors +[[Return to contents]](#Contents) + +## gray +[[Return to contents]](#Contents) + +## green +[[Return to contents]](#Contents) + +## h_divider +[[Return to contents]](#Contents) + +## header +[[Return to contents]](#Contents) + +## header_left +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## hidden +[[Return to contents]](#Contents) + +## hide_cursor +[[Return to contents]](#Contents) + +## highlight_command +[[Return to contents]](#Contents) + +## inverse +[[Return to contents]](#Contents) + +## italic +[[Return to contents]](#Contents) + +## key_pressed +[[Return to contents]](#Contents) + +## magenta +[[Return to contents]](#Contents) + +## move +[[Return to contents]](#Contents) + +## ok_message +[[Return to contents]](#Contents) + +## rapid_blink +[[Return to contents]](#Contents) + +## red +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## rgb +[[Return to contents]](#Contents) + +## set_cursor_position +[[Return to contents]](#Contents) + +## set_tab_title +[[Return to contents]](#Contents) + +## set_terminal_title +[[Return to contents]](#Contents) + +## show_cursor +[[Return to contents]](#Contents) + +## slow_blink +[[Return to contents]](#Contents) + +## strikethrough +[[Return to contents]](#Contents) + +## strip_ansi +[[Return to contents]](#Contents) + +## supports_sixel +[[Return to contents]](#Contents) + +## underline +[[Return to contents]](#Contents) + +## utf8_getchar +[[Return to contents]](#Contents) + +## utf8_len +[[Return to contents]](#Contents) + +## warn_message +[[Return to contents]](#Contents) + +## white +[[Return to contents]](#Contents) + +## yellow +[[Return to contents]](#Contents) + +## C.termios +[[Return to contents]](#Contents) + +## C.winsize +[[Return to contents]](#Contents) + +## Coord +[[Return to contents]](#Contents) + +## KeyPressedParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/term.termios.md b/vdocs/term.termios.md new file mode 100644 index 00000000..9cbaaebb --- /dev/null +++ b/vdocs/term.termios.md @@ -0,0 +1,42 @@ +# module term.termios + + +## Contents +- [flag](#flag) +- [invert](#invert) +- [ioctl](#ioctl) +- [set_state](#set_state) +- [tcgetattr](#tcgetattr) +- [tcsetattr](#tcsetattr) +- [C.termios](#C.termios) +- [Termios](#Termios) + - [disable_echo](#disable_echo) + +## flag +[[Return to contents]](#Contents) + +## invert +[[Return to contents]](#Contents) + +## ioctl +[[Return to contents]](#Contents) + +## set_state +[[Return to contents]](#Contents) + +## tcgetattr +[[Return to contents]](#Contents) + +## tcsetattr +[[Return to contents]](#Contents) + +## C.termios +[[Return to contents]](#Contents) + +## Termios +[[Return to contents]](#Contents) + +## disable_echo +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/term.ui.md b/vdocs/term.ui.md new file mode 100644 index 00000000..11ef96a6 --- /dev/null +++ b/vdocs/term.ui.md @@ -0,0 +1,146 @@ +# module term.ui + + +## Contents +- [Constants](#Constants) +- [init](#init) +- [Direction](#Direction) +- [EventType](#EventType) +- [KeyCode](#KeyCode) +- [Modifiers](#Modifiers) +- [MouseButton](#MouseButton) +- [C.winsize](#C.winsize) +- [Color](#Color) + - [hex](#hex) +- [Config](#Config) +- [Context](#Context) + - [bold](#bold) + - [clear](#clear) + - [draw_dashed_line](#draw_dashed_line) + - [draw_empty_dashed_rect](#draw_empty_dashed_rect) + - [draw_empty_rect](#draw_empty_rect) + - [draw_line](#draw_line) + - [draw_point](#draw_point) + - [draw_rect](#draw_rect) + - [draw_text](#draw_text) + - [flush](#flush) + - [hide_cursor](#hide_cursor) + - [horizontal_separator](#horizontal_separator) + - [reset](#reset) + - [reset_bg_color](#reset_bg_color) + - [reset_color](#reset_color) + - [run](#run) + - [set_bg_color](#set_bg_color) + - [set_color](#set_color) + - [set_cursor_position](#set_cursor_position) + - [set_window_title](#set_window_title) + - [show_cursor](#show_cursor) + - [write](#write) +- [Event](#Event) + +## Constants +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## Direction +[[Return to contents]](#Contents) + +## EventType +[[Return to contents]](#Contents) + +## KeyCode +[[Return to contents]](#Contents) + +## Modifiers +[[Return to contents]](#Contents) + +## MouseButton +[[Return to contents]](#Contents) + +## C.winsize +[[Return to contents]](#Contents) + +## Color +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## bold +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## draw_dashed_line +[[Return to contents]](#Contents) + +## draw_empty_dashed_rect +[[Return to contents]](#Contents) + +## draw_empty_rect +[[Return to contents]](#Contents) + +## draw_line +[[Return to contents]](#Contents) + +## draw_point +[[Return to contents]](#Contents) + +## draw_rect +[[Return to contents]](#Contents) + +## draw_text +[[Return to contents]](#Contents) + +## flush +[[Return to contents]](#Contents) + +## hide_cursor +[[Return to contents]](#Contents) + +## horizontal_separator +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## reset_bg_color +[[Return to contents]](#Contents) + +## reset_color +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## set_bg_color +[[Return to contents]](#Contents) + +## set_color +[[Return to contents]](#Contents) + +## set_cursor_position +[[Return to contents]](#Contents) + +## set_window_title +[[Return to contents]](#Contents) + +## show_cursor +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## Event +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/time.md b/vdocs/time.md new file mode 100644 index 00000000..5f85f1cf --- /dev/null +++ b/vdocs/time.md @@ -0,0 +1,472 @@ +# module time + + +## Contents +- [Constants](#Constants) +- [date_from_days_after_unix_epoch](#date_from_days_after_unix_epoch) +- [day_of_week](#day_of_week) +- [days_from_unix_epoch](#days_from_unix_epoch) +- [days_in_month](#days_in_month) +- [is_leap_year](#is_leap_year) +- [new](#new) +- [new_stopwatch](#new_stopwatch) +- [now](#now) +- [offset](#offset) +- [parse](#parse) +- [parse_format](#parse_format) +- [parse_iso8601](#parse_iso8601) +- [parse_rfc2822](#parse_rfc2822) +- [parse_rfc3339](#parse_rfc3339) +- [portable_timegm](#portable_timegm) +- [since](#since) +- [sleep](#sleep) +- [sys_mono_now](#sys_mono_now) +- [ticks](#ticks) +- [unix](#unix) +- [unix_micro](#unix_micro) +- [unix_microsecond](#unix_microsecond) +- [unix_milli](#unix_milli) +- [unix_nano](#unix_nano) +- [unix_nanosecond](#unix_nanosecond) +- [utc](#utc) +- [Time.new](#Time.new) +- [Duration](#Duration) + - [days](#days) + - [debug](#debug) + - [hours](#hours) + - [microseconds](#microseconds) + - [milliseconds](#milliseconds) + - [minutes](#minutes) + - [nanoseconds](#nanoseconds) + - [seconds](#seconds) + - [str](#str) + - [sys_milliseconds](#sys_milliseconds) + - [timespec](#timespec) +- [FormatDate](#FormatDate) +- [FormatDelimiter](#FormatDelimiter) +- [FormatTime](#FormatTime) +- [C.mach_timebase_info_data_t](#C.mach_timebase_info_data_t) +- [C.timespec](#C.timespec) +- [C.timeval](#C.timeval) +- [C.tm](#C.tm) +- [StopWatch](#StopWatch) + - [start](#start) + - [restart](#restart) + - [stop](#stop) + - [pause](#pause) + - [elapsed](#elapsed) +- [StopWatchOptions](#StopWatchOptions) +- [Time](#Time) + - [-](#-) + - [<](#<) + - [==](#==) + - [add](#add) + - [add_days](#add_days) + - [add_seconds](#add_seconds) + - [as_local](#as_local) + - [as_utc](#as_utc) + - [clean](#clean) + - [clean12](#clean12) + - [custom_format](#custom_format) + - [day_of_week](#day_of_week) + - [days_from_unix_epoch](#days_from_unix_epoch) + - [ddmmy](#ddmmy) + - [debug](#debug) + - [format](#format) + - [format_rfc3339](#format_rfc3339) + - [format_rfc3339_micro](#format_rfc3339_micro) + - [format_rfc3339_nano](#format_rfc3339_nano) + - [format_ss](#format_ss) + - [format_ss_micro](#format_ss_micro) + - [format_ss_milli](#format_ss_milli) + - [format_ss_nano](#format_ss_nano) + - [get_fmt_date_str](#get_fmt_date_str) + - [get_fmt_str](#get_fmt_str) + - [get_fmt_time_str](#get_fmt_time_str) + - [hhmm](#hhmm) + - [hhmm12](#hhmm12) + - [hhmmss](#hhmmss) + - [http_header_string](#http_header_string) + - [is_utc](#is_utc) + - [local](#local) + - [local_to_utc](#local_to_utc) + - [long_weekday_str](#long_weekday_str) + - [md](#md) + - [relative](#relative) + - [relative_short](#relative_short) + - [smonth](#smonth) + - [str](#str) + - [strftime](#strftime) + - [unix](#unix) + - [unix_micro](#unix_micro) + - [unix_milli](#unix_milli) + - [unix_nano](#unix_nano) + - [utc_string](#utc_string) + - [utc_to_local](#utc_to_local) + - [weekday_str](#weekday_str) + - [year_day](#year_day) + - [ymmdd](#ymmdd) +- [TimeParseError](#TimeParseError) + - [msg](#msg) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## date_from_days_after_unix_epoch +[[Return to contents]](#Contents) + +## day_of_week +[[Return to contents]](#Contents) + +## days_from_unix_epoch +[[Return to contents]](#Contents) + +## days_in_month +[[Return to contents]](#Contents) + +## is_leap_year +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## new_stopwatch +[[Return to contents]](#Contents) + +## now +[[Return to contents]](#Contents) + +## offset +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## parse_format +[[Return to contents]](#Contents) + +## parse_iso8601 +[[Return to contents]](#Contents) + +## parse_rfc2822 +[[Return to contents]](#Contents) + +## parse_rfc3339 +[[Return to contents]](#Contents) + +## portable_timegm +[[Return to contents]](#Contents) + +## since +[[Return to contents]](#Contents) + +## sleep +[[Return to contents]](#Contents) + +## sys_mono_now +[[Return to contents]](#Contents) + +## ticks +[[Return to contents]](#Contents) + +## unix +[[Return to contents]](#Contents) + +## unix_micro +[[Return to contents]](#Contents) + +## unix_microsecond +[[Return to contents]](#Contents) + +## unix_milli +[[Return to contents]](#Contents) + +## unix_nano +[[Return to contents]](#Contents) + +## unix_nanosecond +[[Return to contents]](#Contents) + +## utc +[[Return to contents]](#Contents) + +## Time.new +[[Return to contents]](#Contents) + +## Duration +[[Return to contents]](#Contents) + +## days +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## hours +[[Return to contents]](#Contents) + +## microseconds +[[Return to contents]](#Contents) + +## milliseconds +[[Return to contents]](#Contents) + +## minutes +[[Return to contents]](#Contents) + +## nanoseconds +[[Return to contents]](#Contents) + +## seconds +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## sys_milliseconds +[[Return to contents]](#Contents) + +## timespec +[[Return to contents]](#Contents) + +## FormatDate +[[Return to contents]](#Contents) + +## FormatDelimiter +[[Return to contents]](#Contents) + +## FormatTime +[[Return to contents]](#Contents) + +## C.mach_timebase_info_data_t +[[Return to contents]](#Contents) + +## C.timespec +[[Return to contents]](#Contents) + +## C.timeval +[[Return to contents]](#Contents) + +## C.tm +[[Return to contents]](#Contents) + +## StopWatch +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +## restart +[[Return to contents]](#Contents) + +## stop +[[Return to contents]](#Contents) + +## pause +[[Return to contents]](#Contents) + +## elapsed +[[Return to contents]](#Contents) + +## StopWatchOptions +[[Return to contents]](#Contents) + +## Time +[[Return to contents]](#Contents) + +## - +[[Return to contents]](#Contents) + +## < +[[Return to contents]](#Contents) + +## == +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add_days +[[Return to contents]](#Contents) + +## add_seconds +[[Return to contents]](#Contents) + +## as_local +[[Return to contents]](#Contents) + +## as_utc +[[Return to contents]](#Contents) + +## clean +[[Return to contents]](#Contents) + +## clean12 +[[Return to contents]](#Contents) + +## custom_format +[[Return to contents]](#Contents) + +## day_of_week +[[Return to contents]](#Contents) + +## days_from_unix_epoch +[[Return to contents]](#Contents) + +## ddmmy +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## format +[[Return to contents]](#Contents) + +## format_rfc3339 +[[Return to contents]](#Contents) + +## format_rfc3339_micro +[[Return to contents]](#Contents) + +## format_rfc3339_nano +[[Return to contents]](#Contents) + +## format_ss +[[Return to contents]](#Contents) + +## format_ss_micro +[[Return to contents]](#Contents) + +## format_ss_milli +[[Return to contents]](#Contents) + +## format_ss_nano +[[Return to contents]](#Contents) + +## get_fmt_date_str +[[Return to contents]](#Contents) + +## get_fmt_str +[[Return to contents]](#Contents) + +## get_fmt_time_str +[[Return to contents]](#Contents) + +## hhmm +[[Return to contents]](#Contents) + +## hhmm12 +[[Return to contents]](#Contents) + +## hhmmss +[[Return to contents]](#Contents) + +## http_header_string +[[Return to contents]](#Contents) + +## is_utc +[[Return to contents]](#Contents) + +## local +[[Return to contents]](#Contents) + +## local_to_utc +[[Return to contents]](#Contents) + +## long_weekday_str +[[Return to contents]](#Contents) + +## md +[[Return to contents]](#Contents) + +## relative +[[Return to contents]](#Contents) + +## relative_short +[[Return to contents]](#Contents) + +## smonth +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## strftime +[[Return to contents]](#Contents) + +## unix +[[Return to contents]](#Contents) + +## unix_micro +[[Return to contents]](#Contents) + +## unix_milli +[[Return to contents]](#Contents) + +## unix_nano +[[Return to contents]](#Contents) + +## utc_string +[[Return to contents]](#Contents) + +## utc_to_local +[[Return to contents]](#Contents) + +## weekday_str +[[Return to contents]](#Contents) + +## year_day +[[Return to contents]](#Contents) + +## ymmdd +[[Return to contents]](#Contents) + +## TimeParseError +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/time.misc.md b/vdocs/time.misc.md new file mode 100644 index 00000000..ebc8e29c --- /dev/null +++ b/vdocs/time.misc.md @@ -0,0 +1,10 @@ +# module time.misc + + +## Contents +- [random](#random) + +## random +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.ast.md b/vdocs/toml.ast.md new file mode 100644 index 00000000..bf68044a --- /dev/null +++ b/vdocs/toml.ast.md @@ -0,0 +1,126 @@ +# module toml.ast + + +## Contents +- [DateTimeType](#DateTimeType) + - [str](#str) +- [Key](#Key) + - [str](#str) +- [Value](#Value) + - [str](#str) +- [Bare](#Bare) + - [str](#str) +- [Bool](#Bool) + - [str](#str) +- [Comment](#Comment) + - [str](#str) +- [Date](#Date) + - [str](#str) +- [DateTime](#DateTime) + - [str](#str) +- [EOF](#EOF) + - [str](#str) +- [Null](#Null) + - [str](#str) +- [Number](#Number) + - [str](#str) + - [i64](#i64) + - [f64](#f64) +- [Quoted](#Quoted) + - [str](#str) +- [Root](#Root) + - [str](#str) +- [Time](#Time) + - [str](#str) + +## DateTimeType +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Key +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Value +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Bare +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Bool +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Comment +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Date +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## DateTime +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## EOF +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Null +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Number +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## i64 +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## Quoted +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Root +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Time +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.ast.walker.md b/vdocs/toml.ast.walker.md new file mode 100644 index 00000000..b4d6483d --- /dev/null +++ b/vdocs/toml.ast.walker.md @@ -0,0 +1,36 @@ +# module toml.ast.walker + + +## Contents +- [inspect](#inspect) +- [walk](#walk) +- [walk_and_modify](#walk_and_modify) +- [Modifier](#Modifier) +- [Visitor](#Visitor) +- [Inspector](#Inspector) + - [visit](#visit) +- [InspectorFn](#InspectorFn) + +## inspect +[[Return to contents]](#Contents) + +## walk +[[Return to contents]](#Contents) + +## walk_and_modify +[[Return to contents]](#Contents) + +## Modifier +[[Return to contents]](#Contents) + +## Visitor +[[Return to contents]](#Contents) + +## Inspector +## visit +[[Return to contents]](#Contents) + +## InspectorFn +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.checker.md b/vdocs/toml.checker.md new file mode 100644 index 00000000..08dd88bf --- /dev/null +++ b/vdocs/toml.checker.md @@ -0,0 +1,26 @@ +# module toml.checker + + +## Contents +- [Constants](#Constants) +- [Checker](#Checker) + - [check](#check) + - [check_quoted](#check_quoted) + - [check_comment](#check_comment) + +## Constants +[[Return to contents]](#Contents) + +## Checker +[[Return to contents]](#Contents) + +## check +[[Return to contents]](#Contents) + +## check_quoted +[[Return to contents]](#Contents) + +## check_comment +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.decoder.md b/vdocs/toml.decoder.md new file mode 100644 index 00000000..a9feaea0 --- /dev/null +++ b/vdocs/toml.decoder.md @@ -0,0 +1,18 @@ +# module toml.decoder + + +## Contents +- [decode_quoted_escapes](#decode_quoted_escapes) +- [Decoder](#Decoder) + - [decode](#decode) + +## decode_quoted_escapes +[[Return to contents]](#Contents) + +## Decoder +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.input.md b/vdocs/toml.input.md new file mode 100644 index 00000000..22d27838 --- /dev/null +++ b/vdocs/toml.input.md @@ -0,0 +1,14 @@ +# module toml.input + + +## Contents +- [Config](#Config) + - [read_input](#read_input) + +## Config +[[Return to contents]](#Contents) + +## read_input +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.md b/vdocs/toml.md new file mode 100644 index 00000000..6a4e15fe --- /dev/null +++ b/vdocs/toml.md @@ -0,0 +1,194 @@ +# module toml + + +## Contents +- [Constants](#Constants) +- [ast_to_any](#ast_to_any) +- [decode](#decode) +- [encode](#encode) +- [parse_dotted_key](#parse_dotted_key) +- [parse_file](#parse_file) +- [parse_text](#parse_text) +- [Any](#Any) + - [string](#string) + - [to_toml](#to_toml) + - [int](#int) + - [i64](#i64) + - [u64](#u64) + - [f32](#f32) + - [f64](#f64) + - [array](#array) + - [as_map](#as_map) + - [bool](#bool) + - [date](#date) + - [time](#time) + - [datetime](#datetime) + - [default_to](#default_to) + - [value](#value) + - [value_opt](#value_opt) + - [reflect](#reflect) +- [[]Any](#[]Any) + - [value](#value) + - [as_strings](#as_strings) + - [to_toml](#to_toml) +- [map[string]Any](#map[string]Any) + - [value](#value) + - [as_strings](#as_strings) + - [to_toml](#to_toml) + - [to_inline_toml](#to_inline_toml) +- [Config](#Config) +- [Date](#Date) + - [str](#str) +- [DateTime](#DateTime) + - [str](#str) +- [Doc](#Doc) + - [decode](#decode) + - [to_any](#to_any) + - [reflect](#reflect) + - [value](#value) + - [value_opt](#value_opt) +- [Null](#Null) +- [Time](#Time) + - [str](#str) + +## Constants +[[Return to contents]](#Contents) + +## ast_to_any +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## parse_dotted_key +[[Return to contents]](#Contents) + +## parse_file +[[Return to contents]](#Contents) + +## parse_text +[[Return to contents]](#Contents) + +## Any +[[Return to contents]](#Contents) + +## string +[[Return to contents]](#Contents) + +## to_toml +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## i64 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## f32 +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## array +[[Return to contents]](#Contents) + +## as_map +[[Return to contents]](#Contents) + +## bool +[[Return to contents]](#Contents) + +## date +[[Return to contents]](#Contents) + +## time +[[Return to contents]](#Contents) + +## datetime +[[Return to contents]](#Contents) + +## default_to +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## value_opt +[[Return to contents]](#Contents) + +## reflect +[[Return to contents]](#Contents) + +## []Any +## value +[[Return to contents]](#Contents) + +## as_strings +[[Return to contents]](#Contents) + +## to_toml +[[Return to contents]](#Contents) + +## map[string]Any +## value +[[Return to contents]](#Contents) + +## as_strings +[[Return to contents]](#Contents) + +## to_toml +[[Return to contents]](#Contents) + +## to_inline_toml +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## Date +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## DateTime +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Doc +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +## to_any +[[Return to contents]](#Contents) + +## reflect +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## value_opt +[[Return to contents]](#Contents) + +## Null +[[Return to contents]](#Contents) + +## Time +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.parser.md b/vdocs/toml.parser.md new file mode 100644 index 00000000..9c21f6e2 --- /dev/null +++ b/vdocs/toml.parser.md @@ -0,0 +1,160 @@ +# module toml.parser + + +## Contents +- [Constants](#Constants) +- [new_parser](#new_parser) +- [DottedKey](#DottedKey) + - [str](#str) +- [Config](#Config) +- [Parser](#Parser) + - [init](#init) + - [parse](#parse) + - [find_table](#find_table) + - [allocate_table](#allocate_table) + - [sub_table_key](#sub_table_key) + - [find_sub_table](#find_sub_table) + - [find_in_table](#find_in_table) + - [find_array_of_tables](#find_array_of_tables) + - [allocate_in_table](#allocate_in_table) + - [dotted_key](#dotted_key) + - [root_table](#root_table) + - [table_contents](#table_contents) + - [inline_table](#inline_table) + - [array_of_tables](#array_of_tables) + - [array_of_tables_contents](#array_of_tables_contents) + - [double_array_of_tables](#double_array_of_tables) + - [double_array_of_tables_contents](#double_array_of_tables_contents) + - [array](#array) + - [comment](#comment) + - [key](#key) + - [key_value](#key_value) + - [dotted_key_value](#dotted_key_value) + - [value](#value) + - [number_or_date](#number_or_date) + - [bare](#bare) + - [quoted](#quoted) + - [boolean](#boolean) + - [number](#number) + - [date_time](#date_time) + - [date](#date) + - [time](#time) + - [eof](#eof) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new_parser +[[Return to contents]](#Contents) + +## DottedKey +## str +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## Parser +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## find_table +[[Return to contents]](#Contents) + +## allocate_table +[[Return to contents]](#Contents) + +## sub_table_key +[[Return to contents]](#Contents) + +## find_sub_table +[[Return to contents]](#Contents) + +## find_in_table +[[Return to contents]](#Contents) + +## find_array_of_tables +[[Return to contents]](#Contents) + +## allocate_in_table +[[Return to contents]](#Contents) + +## dotted_key +[[Return to contents]](#Contents) + +## root_table +[[Return to contents]](#Contents) + +## table_contents +[[Return to contents]](#Contents) + +## inline_table +[[Return to contents]](#Contents) + +## array_of_tables +[[Return to contents]](#Contents) + +## array_of_tables_contents +[[Return to contents]](#Contents) + +## double_array_of_tables +[[Return to contents]](#Contents) + +## double_array_of_tables_contents +[[Return to contents]](#Contents) + +## array +[[Return to contents]](#Contents) + +## comment +[[Return to contents]](#Contents) + +## key +[[Return to contents]](#Contents) + +## key_value +[[Return to contents]](#Contents) + +## dotted_key_value +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## number_or_date +[[Return to contents]](#Contents) + +## bare +[[Return to contents]](#Contents) + +## quoted +[[Return to contents]](#Contents) + +## boolean +[[Return to contents]](#Contents) + +## number +[[Return to contents]](#Contents) + +## date_time +[[Return to contents]](#Contents) + +## date +[[Return to contents]](#Contents) + +## time +[[Return to contents]](#Contents) + +## eof +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.scanner.md b/vdocs/toml.scanner.md new file mode 100644 index 00000000..59dc505d --- /dev/null +++ b/vdocs/toml.scanner.md @@ -0,0 +1,84 @@ +# module toml.scanner + + +## Contents +- [Constants](#Constants) +- [new_scanner](#new_scanner) +- [new_simple](#new_simple) +- [new_simple_file](#new_simple_file) +- [new_simple_text](#new_simple_text) +- [Config](#Config) +- [Scanner](#Scanner) + - [scan](#scan) + - [free](#free) + - [remaining](#remaining) + - [next](#next) + - [skip](#skip) + - [skip_n](#skip_n) + - [at](#at) + - [peek](#peek) + - [reset](#reset) + - [excerpt](#excerpt) + - [state](#state) +- [State](#State) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new_scanner +[[Return to contents]](#Contents) + +## new_simple +[[Return to contents]](#Contents) + +## new_simple_file +[[Return to contents]](#Contents) + +## new_simple_text +[[Return to contents]](#Contents) + +## Config +[[Return to contents]](#Contents) + +## Scanner +[[Return to contents]](#Contents) + +## scan +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## remaining +[[Return to contents]](#Contents) + +## next +[[Return to contents]](#Contents) + +## skip +[[Return to contents]](#Contents) + +## skip_n +[[Return to contents]](#Contents) + +## at +[[Return to contents]](#Contents) + +## peek +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## excerpt +[[Return to contents]](#Contents) + +## state +[[Return to contents]](#Contents) + +## State +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.to.md b/vdocs/toml.to.md new file mode 100644 index 00000000..1e2cb9b7 --- /dev/null +++ b/vdocs/toml.to.md @@ -0,0 +1,14 @@ +# module toml.to + + +## Contents +- [json](#json) +- [json_any](#json_any) + +## json +[[Return to contents]](#Contents) + +## json_any +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.token.md b/vdocs/toml.token.md new file mode 100644 index 00000000..ce2accf1 --- /dev/null +++ b/vdocs/toml.token.md @@ -0,0 +1,22 @@ +# module toml.token + + +## Contents +- [Kind](#Kind) +- [Pos](#Pos) +- [Token](#Token) + - [pos](#pos) + +## Kind +[[Return to contents]](#Contents) + +## Pos +[[Return to contents]](#Contents) + +## Token +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/toml.util.md b/vdocs/toml.util.md new file mode 100644 index 00000000..2e647e99 --- /dev/null +++ b/vdocs/toml.util.md @@ -0,0 +1,22 @@ +# module toml.util + + +## Contents +- [is_ascii_control_character](#is_ascii_control_character) +- [is_illegal_ascii_control_character](#is_illegal_ascii_control_character) +- [is_key_char](#is_key_char) +- [printdbg](#printdbg) + +## is_ascii_control_character +[[Return to contents]](#Contents) + +## is_illegal_ascii_control_character +[[Return to contents]](#Contents) + +## is_key_char +[[Return to contents]](#Contents) + +## printdbg +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.ast.md b/vdocs/v.ast.md new file mode 100644 index 00000000..c37e37a6 --- /dev/null +++ b/vdocs/v.ast.md @@ -0,0 +1,2106 @@ +# module v.ast + + +## Contents +- [Constants](#Constants) +- [all_registers](#all_registers) +- [args2str](#args2str) +- [idx_to_type](#idx_to_type) +- [merge_types](#merge_types) +- [mktyp](#mktyp) +- [new_table](#new_table) +- [new_type](#new_type) +- [new_type_ptr](#new_type_ptr) +- [pref_arch_to_table_language](#pref_arch_to_table_language) +- [sharetype_from_flags](#sharetype_from_flags) +- [type_can_start_with_token](#type_can_start_with_token) +- [validate_type_string_is_pure_literal](#validate_type_string_is_pure_literal) +- [AsmArg](#AsmArg) +- [ComptTimeConstValue](#ComptTimeConstValue) + - [i8](#i8) + - [i16](#i16) + - [int](#int) + - [i32](#i32) + - [voidptr](#voidptr) + - [i64](#i64) + - [u8](#u8) + - [u16](#u16) + - [u32](#u32) + - [u64](#u64) + - [f32](#f32) + - [f64](#f64) + - [string](#string) +- [EmptyExpr](#EmptyExpr) +- [Expr](#Expr) + - [get_pure_type](#get_pure_type) + - [has_fn_call](#has_fn_call) + - [is_as_cast](#is_as_cast) + - [is_auto_deref_var](#is_auto_deref_var) + - [is_blank_ident](#is_blank_ident) + - [is_expr](#is_expr) + - [is_literal](#is_literal) + - [is_lockable](#is_lockable) + - [is_lvalue](#is_lvalue) + - [is_nil](#is_nil) + - [is_pure_literal](#is_pure_literal) + - [is_reference](#is_reference) + - [pos](#pos) + - [str](#str) +- [FnPanicHandler](#FnPanicHandler) +- [IdentInfo](#IdentInfo) +- [Node](#Node) + - [pos](#pos) + - [children](#children) +- [ScopeObject](#ScopeObject) + - [is_simple_define_const](#is_simple_define_const) +- [Stmt](#Stmt) + - [str](#str) +- [Type](#Type) + - [atomic_typename](#atomic_typename) + - [share](#share) + - [idx](#idx) + - [is_void](#is_void) + - [is_full](#is_full) + - [nr_muls](#nr_muls) + - [is_ptr](#is_ptr) + - [is_pointer](#is_pointer) + - [is_voidptr](#is_voidptr) + - [is_any_kind_of_pointer](#is_any_kind_of_pointer) + - [set_nr_muls](#set_nr_muls) + - [ref](#ref) + - [deref](#deref) + - [has_flag](#has_flag) + - [set_flag](#set_flag) + - [clear_flag](#clear_flag) + - [clear_flags](#clear_flags) + - [clear_option_and_result](#clear_option_and_result) + - [has_option_or_result](#has_option_or_result) + - [str](#str) + - [debug](#debug) + - [derive](#derive) + - [derive_add_muls](#derive_add_muls) + - [idx_type](#idx_type) + - [is_float](#is_float) + - [is_int](#is_int) + - [is_int_valptr](#is_int_valptr) + - [is_float_valptr](#is_float_valptr) + - [is_pure_int](#is_pure_int) + - [is_pure_float](#is_pure_float) + - [is_signed](#is_signed) + - [is_unsigned](#is_unsigned) + - [flip_signedness](#flip_signedness) + - [is_int_literal](#is_int_literal) + - [is_number](#is_number) + - [is_string](#is_string) + - [is_bool](#is_bool) +- [TypeDecl](#TypeDecl) +- [TypeInfo](#TypeInfo) +- [[]Attr](#[]Attr) + - [contains](#contains) + - [contains_arg](#contains_arg) + - [find_first](#find_first) + - [find_last](#find_last) + - [find_comptime_define](#find_comptime_define) +- [[]Kind](#[]Kind) + - [str](#str) +- [AddressingMode](#AddressingMode) +- [AttrKind](#AttrKind) +- [ComptimeForKind](#ComptimeForKind) + - [str](#str) +- [ComptimeTypeKind](#ComptimeTypeKind) +- [ComptimeVarKind](#ComptimeVarKind) +- [GenericKindField](#GenericKindField) +- [IdentKind](#IdentKind) +- [Kind](#Kind) + - [str](#str) +- [Language](#Language) +- [OrKind](#OrKind) +- [ShareType](#ShareType) + - [str](#str) +- [SqlExprKind](#SqlExprKind) +- [SqlStmtKind](#SqlStmtKind) +- [StructInitKind](#StructInitKind) +- [TypeFlag](#TypeFlag) +- [Aggregate](#Aggregate) +- [Alias](#Alias) +- [AliasTypeDecl](#AliasTypeDecl) +- [AnonFn](#AnonFn) +- [Array](#Array) +- [ArrayDecompose](#ArrayDecompose) +- [ArrayFixed](#ArrayFixed) + - [is_compatible](#is_compatible) +- [ArrayInit](#ArrayInit) +- [AsCast](#AsCast) +- [AsmAddressing](#AsmAddressing) +- [AsmAlias](#AsmAlias) +- [AsmClobbered](#AsmClobbered) +- [AsmDisp](#AsmDisp) +- [AsmIO](#AsmIO) +- [AsmRegister](#AsmRegister) +- [AsmStmt](#AsmStmt) +- [AsmTemplate](#AsmTemplate) +- [AssertStmt](#AssertStmt) +- [AssignStmt](#AssignStmt) +- [Assoc](#Assoc) +- [AtExpr](#AtExpr) +- [Attr](#Attr) + - [debug](#debug) + - [str](#str) +- [Block](#Block) +- [BoolLiteral](#BoolLiteral) +- [BranchStmt](#BranchStmt) + - [str](#str) +- [CTempVar](#CTempVar) +- [CallArg](#CallArg) + - [str](#str) +- [CallExpr](#CallExpr) + - [fkey](#fkey) + - [get_name](#get_name) +- [CastExpr](#CastExpr) +- [Chan](#Chan) +- [ChanInit](#ChanInit) +- [CharLiteral](#CharLiteral) +- [Comment](#Comment) +- [ComptimeCall](#ComptimeCall) + - [resolve_compile_value](#resolve_compile_value) + - [expr_str](#expr_str) +- [ComptimeFor](#ComptimeFor) +- [ComptimeSelector](#ComptimeSelector) +- [ComptimeType](#ComptimeType) + - [str](#str) +- [ConcatExpr](#ConcatExpr) +- [ConstDecl](#ConstDecl) +- [ConstField](#ConstField) + - [comptime_expr_value](#comptime_expr_value) + - [is_simple_define_const](#is_simple_define_const) +- [DebuggerStmt](#DebuggerStmt) +- [DeferStmt](#DeferStmt) +- [DumpExpr](#DumpExpr) +- [Embed](#Embed) +- [EmbeddedFile](#EmbeddedFile) + - [hash](#hash) +- [EmptyNode](#EmptyNode) +- [EmptyStmt](#EmptyStmt) +- [Enum](#Enum) +- [EnumDecl](#EnumDecl) +- [EnumField](#EnumField) +- [EnumVal](#EnumVal) +- [ExprStmt](#ExprStmt) +- [File](#File) + - [free](#free) +- [FloatLiteral](#FloatLiteral) +- [Fn](#Fn) + - [fkey](#fkey) + - [new_method_with_receiver_type](#new_method_with_receiver_type) +- [FnDecl](#FnDecl) + - [fkey](#fkey) + - [get_name](#get_name) + - [modname](#modname) + - [new_method_with_receiver_type](#new_method_with_receiver_type) +- [FnSignatureOpts](#FnSignatureOpts) +- [FnTrace](#FnTrace) +- [FnType](#FnType) +- [FnTypeDecl](#FnTypeDecl) +- [ForCStmt](#ForCStmt) +- [ForInStmt](#ForInStmt) +- [ForStmt](#ForStmt) +- [GenericInst](#GenericInst) +- [GetEmbedsOptions](#GetEmbedsOptions) +- [GlobalDecl](#GlobalDecl) +- [GlobalField](#GlobalField) +- [GoExpr](#GoExpr) +- [GotoLabel](#GotoLabel) +- [GotoStmt](#GotoStmt) +- [HashStmt](#HashStmt) +- [Ident](#Ident) + - [full_name](#full_name) + - [is_auto_heap](#is_auto_heap) + - [is_mut](#is_mut) + - [var_info](#var_info) +- [IdentFn](#IdentFn) +- [IdentVar](#IdentVar) +- [IfBranch](#IfBranch) +- [IfExpr](#IfExpr) +- [IfGuardExpr](#IfGuardExpr) +- [IfGuardVar](#IfGuardVar) +- [Import](#Import) +- [ImportSymbol](#ImportSymbol) +- [IndexExpr](#IndexExpr) + - [recursive_mapset_is_setter](#recursive_mapset_is_setter) + - [recursive_arraymap_set_is_setter](#recursive_arraymap_set_is_setter) +- [InfixExpr](#InfixExpr) +- [IntegerLiteral](#IntegerLiteral) +- [Interface](#Interface) + - [find_field](#find_field) + - [find_method](#find_method) + - [has_method](#has_method) + - [defines_method](#defines_method) + - [get_methods](#get_methods) +- [InterfaceDecl](#InterfaceDecl) +- [InterfaceEmbedding](#InterfaceEmbedding) +- [IsRefType](#IsRefType) +- [LambdaExpr](#LambdaExpr) +- [Likely](#Likely) +- [LockExpr](#LockExpr) +- [Map](#Map) +- [MapInit](#MapInit) +- [MatchBranch](#MatchBranch) +- [MatchExpr](#MatchExpr) +- [Module](#Module) +- [MultiReturn](#MultiReturn) +- [Nil](#Nil) +- [NodeError](#NodeError) +- [None](#None) +- [OffsetOf](#OffsetOf) +- [OrExpr](#OrExpr) +- [ParExpr](#ParExpr) +- [Param](#Param) + - [specifier](#specifier) +- [PostfixExpr](#PostfixExpr) +- [PrefixExpr](#PrefixExpr) +- [RangeExpr](#RangeExpr) +- [Return](#Return) +- [Scope](#Scope) + - [free](#free) + - [find](#find) + - [find_struct_field](#find_struct_field) + - [find_var](#find_var) + - [find_global](#find_global) + - [find_const](#find_const) + - [known_var](#known_var) + - [known_global](#known_global) + - [known_const](#known_const) + - [update_var_type](#update_var_type) + - [update_ct_var_kind](#update_ct_var_kind) + - [update_smartcasts](#update_smartcasts) + - [register_struct_field](#register_struct_field) + - [register](#register) + - [innermost](#innermost) + - [get_all_vars](#get_all_vars) + - [contains](#contains) + - [has_inherited_vars](#has_inherited_vars) + - [is_inherited_var](#is_inherited_var) + - [show](#show) + - [mark_var_as_used](#mark_var_as_used) + - [str](#str) +- [ScopeStructField](#ScopeStructField) +- [SelectBranch](#SelectBranch) +- [SelectExpr](#SelectExpr) +- [SelectorExpr](#SelectorExpr) + - [root_ident](#root_ident) +- [SemicolonStmt](#SemicolonStmt) +- [SizeOf](#SizeOf) +- [SpawnExpr](#SpawnExpr) +- [SqlExpr](#SqlExpr) +- [SqlStmt](#SqlStmt) +- [SqlStmtLine](#SqlStmtLine) +- [StringInterLiteral](#StringInterLiteral) + - [get_fspec_braces](#get_fspec_braces) +- [StringLiteral](#StringLiteral) +- [Struct](#Struct) + - [is_empty_struct](#is_empty_struct) + - [is_unresolved_generic](#is_unresolved_generic) + - [find_field](#find_field) + - [get_field](#get_field) +- [StructDecl](#StructDecl) +- [StructField](#StructField) + - [equals](#equals) +- [StructInit](#StructInit) +- [StructInitField](#StructInitField) +- [SumType](#SumType) + - [find_sum_type_field](#find_sum_type_field) +- [SumTypeDecl](#SumTypeDecl) +- [Table](#Table) + - [add_placeholder_type](#add_placeholder_type) + - [array_cname](#array_cname) + - [array_fixed_cname](#array_fixed_cname) + - [array_fixed_name](#array_fixed_name) + - [array_name](#array_name) + - [bitsize_to_type](#bitsize_to_type) + - [chan_cname](#chan_cname) + - [chan_name](#chan_name) + - [check_if_elements_need_unwrap](#check_if_elements_need_unwrap) + - [clean_generics_type_str](#clean_generics_type_str) + - [complete_interface_check](#complete_interface_check) + - [convert_generic_static_type_name](#convert_generic_static_type_name) + - [convert_generic_type](#convert_generic_type) + - [dependent_names_in_expr](#dependent_names_in_expr) + - [dependent_names_in_stmt](#dependent_names_in_stmt) + - [does_type_implement_interface](#does_type_implement_interface) + - [final_sym](#final_sym) + - [final_type](#final_type) + - [find_enum_field_val](#find_enum_field_val) + - [find_field](#find_field) + - [find_field_from_embeds](#find_field_from_embeds) + - [find_field_with_embeds](#find_field_with_embeds) + - [find_fn](#find_fn) + - [find_method](#find_method) + - [find_method_from_embeds](#find_method_from_embeds) + - [find_method_with_embeds](#find_method_with_embeds) + - [find_missing_variants](#find_missing_variants) + - [find_or_register_array](#find_or_register_array) + - [find_or_register_array_fixed](#find_or_register_array_fixed) + - [find_or_register_array_with_dims](#find_or_register_array_with_dims) + - [find_or_register_chan](#find_or_register_chan) + - [find_or_register_fn_type](#find_or_register_fn_type) + - [find_or_register_map](#find_or_register_map) + - [find_or_register_multi_return](#find_or_register_multi_return) + - [find_or_register_promise](#find_or_register_promise) + - [find_or_register_thread](#find_or_register_thread) + - [find_sym](#find_sym) + - [find_sym_and_type_idx](#find_sym_and_type_idx) + - [find_type](#find_type) + - [find_type_idx](#find_type_idx) + - [find_type_idx_fn_scoped](#find_type_idx_fn_scoped) + - [fn_signature](#fn_signature) + - [fn_signature_using_aliases](#fn_signature_using_aliases) + - [fn_type_signature](#fn_type_signature) + - [fn_type_source_signature](#fn_type_source_signature) + - [free](#free) + - [generic_insts_to_concrete](#generic_insts_to_concrete) + - [generic_type_names](#generic_type_names) + - [get_anon_fn_name](#get_anon_fn_name) + - [get_array_dims](#get_array_dims) + - [get_attrs](#get_attrs) + - [get_embed_methods](#get_embed_methods) + - [get_embeds](#get_embeds) + - [get_enum_field_names](#get_enum_field_names) + - [get_enum_field_vals](#get_enum_field_vals) + - [get_final_type_name](#get_final_type_name) + - [get_generic_names](#get_generic_names) + - [get_trace_fn_name](#get_trace_fn_name) + - [get_type_name](#get_type_name) + - [get_veb_result_type_idx](#get_veb_result_type_idx) + - [has_cflag](#has_cflag) + - [has_deep_child_no_ref](#has_deep_child_no_ref) + - [has_method](#has_method) + - [is_interface_smartcast](#is_interface_smartcast) + - [is_interface_var](#is_interface_var) + - [is_same_method](#is_same_method) + - [is_sumtype_or_in_variant](#is_sumtype_or_in_variant) + - [known_fn](#known_fn) + - [known_type](#known_type) + - [known_type_idx](#known_type_idx) + - [known_type_names](#known_type_names) + - [map_cname](#map_cname) + - [map_name](#map_name) + - [panic](#panic) + - [parse_cflag](#parse_cflag) + - [promise_cname](#promise_cname) + - [promise_name](#promise_name) + - [register_aggregate_method](#register_aggregate_method) + - [register_anon_struct](#register_anon_struct) + - [register_anon_union](#register_anon_union) + - [register_builtin_type_symbols](#register_builtin_type_symbols) + - [register_enum_decl](#register_enum_decl) + - [register_fn](#register_fn) + - [register_fn_concrete_types](#register_fn_concrete_types) + - [register_fn_generic_types](#register_fn_generic_types) + - [register_interface](#register_interface) + - [register_sumtype](#register_sumtype) + - [register_sym](#register_sym) + - [reset_parsing_type](#reset_parsing_type) + - [resolve_common_sumtype_fields](#resolve_common_sumtype_fields) + - [resolve_init](#resolve_init) + - [start_parsing_type](#start_parsing_type) + - [stringify_anon_decl](#stringify_anon_decl) + - [stringify_fn_decl](#stringify_fn_decl) + - [struct_fields](#struct_fields) + - [struct_has_field](#struct_has_field) + - [sumtype_has_variant](#sumtype_has_variant) + - [sym](#sym) + - [sym_by_idx](#sym_by_idx) + - [thread_cname](#thread_cname) + - [thread_name](#thread_name) + - [type_is_for_pointer_arithmetic](#type_is_for_pointer_arithmetic) + - [type_kind](#type_kind) + - [type_size](#type_size) + - [type_str](#type_str) + - [type_to_code](#type_to_code) + - [type_to_str](#type_to_str) + - [type_to_str_using_aliases](#type_to_str_using_aliases) + - [unalias_num_type](#unalias_num_type) + - [unaliased_type](#unaliased_type) + - [unwrap_generic_type](#unwrap_generic_type) + - [unwrap_generic_type_ex](#unwrap_generic_type_ex) + - [value_type](#value_type) +- [Thread](#Thread) +- [TypeNode](#TypeNode) +- [TypeOf](#TypeOf) +- [TypeSymbol](#TypeSymbol) + - [array_fixed_info](#array_fixed_info) + - [array_info](#array_info) + - [chan_info](#chan_info) + - [dbg](#dbg) + - [debug](#debug) + - [embed_name](#embed_name) + - [enum_info](#enum_info) + - [find_field](#find_field) + - [find_method](#find_method) + - [find_method_with_generic_parent](#find_method_with_generic_parent) + - [get_methods](#get_methods) + - [has_field](#has_field) + - [has_method](#has_method) + - [has_method_with_generic_parent](#has_method_with_generic_parent) + - [is_array_fixed](#is_array_fixed) + - [is_array_fixed_ret](#is_array_fixed_ret) + - [is_bool](#is_bool) + - [is_builtin](#is_builtin) + - [is_c_struct](#is_c_struct) + - [is_empty_struct_array](#is_empty_struct_array) + - [is_float](#is_float) + - [is_heap](#is_heap) + - [is_int](#is_int) + - [is_js_compatible](#is_js_compatible) + - [is_number](#is_number) + - [is_pointer](#is_pointer) + - [is_primitive](#is_primitive) + - [is_primitive_fixed_array](#is_primitive_fixed_array) + - [is_string](#is_string) + - [map_info](#map_info) + - [mr_info](#mr_info) + - [nr_dims](#nr_dims) + - [register_method](#register_method) + - [scoped_cname](#scoped_cname) + - [scoped_name](#scoped_name) + - [str](#str) + - [str_method_info](#str_method_info) + - [struct_info](#struct_info) + - [sumtype_info](#sumtype_info) + - [symbol_name_except_generic](#symbol_name_except_generic) + - [thread_info](#thread_info) + - [update_method](#update_method) +- [UnknownTypeInfo](#UnknownTypeInfo) +- [UnsafeExpr](#UnsafeExpr) +- [UsedFeatures](#UsedFeatures) + - [free](#free) +- [Var](#Var) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## all_registers +[[Return to contents]](#Contents) + +## args2str +[[Return to contents]](#Contents) + +## idx_to_type +[[Return to contents]](#Contents) + +## merge_types +[[Return to contents]](#Contents) + +## mktyp +[[Return to contents]](#Contents) + +## new_table +[[Return to contents]](#Contents) + +## new_type +[[Return to contents]](#Contents) + +## new_type_ptr +[[Return to contents]](#Contents) + +## pref_arch_to_table_language +[[Return to contents]](#Contents) + +## sharetype_from_flags +[[Return to contents]](#Contents) + +## type_can_start_with_token +[[Return to contents]](#Contents) + +## validate_type_string_is_pure_literal +[[Return to contents]](#Contents) + +## AsmArg +[[Return to contents]](#Contents) + +## ComptTimeConstValue +[[Return to contents]](#Contents) + +## i8 +[[Return to contents]](#Contents) + +## i16 +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## i32 +[[Return to contents]](#Contents) + +## voidptr +[[Return to contents]](#Contents) + +## i64 +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## u16 +[[Return to contents]](#Contents) + +## u32 +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## f32 +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## string +[[Return to contents]](#Contents) + +## EmptyExpr +[[Return to contents]](#Contents) + +## Expr +[[Return to contents]](#Contents) + +## get_pure_type +[[Return to contents]](#Contents) + +## has_fn_call +[[Return to contents]](#Contents) + +## is_as_cast +[[Return to contents]](#Contents) + +## is_auto_deref_var +[[Return to contents]](#Contents) + +## is_blank_ident +[[Return to contents]](#Contents) + +## is_expr +[[Return to contents]](#Contents) + +## is_literal +[[Return to contents]](#Contents) + +## is_lockable +[[Return to contents]](#Contents) + +## is_lvalue +[[Return to contents]](#Contents) + +## is_nil +[[Return to contents]](#Contents) + +## is_pure_literal +[[Return to contents]](#Contents) + +## is_reference +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## FnPanicHandler +[[Return to contents]](#Contents) + +## IdentInfo +[[Return to contents]](#Contents) + +## Node +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +## children +[[Return to contents]](#Contents) + +## ScopeObject +[[Return to contents]](#Contents) + +## is_simple_define_const +[[Return to contents]](#Contents) + +## Stmt +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Type +[[Return to contents]](#Contents) + +## atomic_typename +[[Return to contents]](#Contents) + +## share +[[Return to contents]](#Contents) + +## idx +[[Return to contents]](#Contents) + +## is_void +[[Return to contents]](#Contents) + +## is_full +[[Return to contents]](#Contents) + +## nr_muls +[[Return to contents]](#Contents) + +## is_ptr +[[Return to contents]](#Contents) + +## is_pointer +[[Return to contents]](#Contents) + +## is_voidptr +[[Return to contents]](#Contents) + +## is_any_kind_of_pointer +[[Return to contents]](#Contents) + +## set_nr_muls +[[Return to contents]](#Contents) + +## ref +[[Return to contents]](#Contents) + +## deref +[[Return to contents]](#Contents) + +## has_flag +[[Return to contents]](#Contents) + +## set_flag +[[Return to contents]](#Contents) + +## clear_flag +[[Return to contents]](#Contents) + +## clear_flags +[[Return to contents]](#Contents) + +## clear_option_and_result +[[Return to contents]](#Contents) + +## has_option_or_result +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## derive +[[Return to contents]](#Contents) + +## derive_add_muls +[[Return to contents]](#Contents) + +## idx_type +[[Return to contents]](#Contents) + +## is_float +[[Return to contents]](#Contents) + +## is_int +[[Return to contents]](#Contents) + +## is_int_valptr +[[Return to contents]](#Contents) + +## is_float_valptr +[[Return to contents]](#Contents) + +## is_pure_int +[[Return to contents]](#Contents) + +## is_pure_float +[[Return to contents]](#Contents) + +## is_signed +[[Return to contents]](#Contents) + +## is_unsigned +[[Return to contents]](#Contents) + +## flip_signedness +[[Return to contents]](#Contents) + +## is_int_literal +[[Return to contents]](#Contents) + +## is_number +[[Return to contents]](#Contents) + +## is_string +[[Return to contents]](#Contents) + +## is_bool +[[Return to contents]](#Contents) + +## TypeDecl +[[Return to contents]](#Contents) + +## TypeInfo +[[Return to contents]](#Contents) + +## []Attr +## contains +[[Return to contents]](#Contents) + +## contains_arg +[[Return to contents]](#Contents) + +## find_first +[[Return to contents]](#Contents) + +## find_last +[[Return to contents]](#Contents) + +## find_comptime_define +[[Return to contents]](#Contents) + +## []Kind +## str +[[Return to contents]](#Contents) + +## AddressingMode +[[Return to contents]](#Contents) + +## AttrKind +[[Return to contents]](#Contents) + +## ComptimeForKind +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ComptimeTypeKind +[[Return to contents]](#Contents) + +## ComptimeVarKind +[[Return to contents]](#Contents) + +## GenericKindField +[[Return to contents]](#Contents) + +## IdentKind +[[Return to contents]](#Contents) + +## Kind +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Language +[[Return to contents]](#Contents) + +## OrKind +[[Return to contents]](#Contents) + +## ShareType +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## SqlExprKind +[[Return to contents]](#Contents) + +## SqlStmtKind +[[Return to contents]](#Contents) + +## StructInitKind +[[Return to contents]](#Contents) + +## TypeFlag +[[Return to contents]](#Contents) + +## Aggregate +[[Return to contents]](#Contents) + +## Alias +[[Return to contents]](#Contents) + +## AliasTypeDecl +[[Return to contents]](#Contents) + +## AnonFn +[[Return to contents]](#Contents) + +## Array +[[Return to contents]](#Contents) + +## ArrayDecompose +[[Return to contents]](#Contents) + +## ArrayFixed +[[Return to contents]](#Contents) + +## is_compatible +[[Return to contents]](#Contents) + +## ArrayInit +[[Return to contents]](#Contents) + +## AsCast +[[Return to contents]](#Contents) + +## AsmAddressing +[[Return to contents]](#Contents) + +## AsmAlias +[[Return to contents]](#Contents) + +## AsmClobbered +[[Return to contents]](#Contents) + +## AsmDisp +[[Return to contents]](#Contents) + +## AsmIO +[[Return to contents]](#Contents) + +## AsmRegister +[[Return to contents]](#Contents) + +## AsmStmt +[[Return to contents]](#Contents) + +## AsmTemplate +[[Return to contents]](#Contents) + +## AssertStmt +[[Return to contents]](#Contents) + +## AssignStmt +[[Return to contents]](#Contents) + +## Assoc +[[Return to contents]](#Contents) + +## AtExpr +[[Return to contents]](#Contents) + +## Attr +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## Block +[[Return to contents]](#Contents) + +## BoolLiteral +[[Return to contents]](#Contents) + +## BranchStmt +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## CTempVar +[[Return to contents]](#Contents) + +## CallArg +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## CallExpr +[[Return to contents]](#Contents) + +## fkey +[[Return to contents]](#Contents) + +## get_name +[[Return to contents]](#Contents) + +## CastExpr +[[Return to contents]](#Contents) + +## Chan +[[Return to contents]](#Contents) + +## ChanInit +[[Return to contents]](#Contents) + +## CharLiteral +[[Return to contents]](#Contents) + +## Comment +[[Return to contents]](#Contents) + +## ComptimeCall +[[Return to contents]](#Contents) + +## resolve_compile_value +[[Return to contents]](#Contents) + +## expr_str +[[Return to contents]](#Contents) + +## ComptimeFor +[[Return to contents]](#Contents) + +## ComptimeSelector +[[Return to contents]](#Contents) + +## ComptimeType +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ConcatExpr +[[Return to contents]](#Contents) + +## ConstDecl +[[Return to contents]](#Contents) + +## ConstField +[[Return to contents]](#Contents) + +## comptime_expr_value +[[Return to contents]](#Contents) + +## is_simple_define_const +[[Return to contents]](#Contents) + +## DebuggerStmt +[[Return to contents]](#Contents) + +## DeferStmt +[[Return to contents]](#Contents) + +## DumpExpr +[[Return to contents]](#Contents) + +## Embed +[[Return to contents]](#Contents) + +## EmbeddedFile +[[Return to contents]](#Contents) + +## hash +[[Return to contents]](#Contents) + +## EmptyNode +[[Return to contents]](#Contents) + +## EmptyStmt +[[Return to contents]](#Contents) + +## Enum +[[Return to contents]](#Contents) + +## EnumDecl +[[Return to contents]](#Contents) + +## EnumField +[[Return to contents]](#Contents) + +## EnumVal +[[Return to contents]](#Contents) + +## ExprStmt +[[Return to contents]](#Contents) + +## File +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## FloatLiteral +[[Return to contents]](#Contents) + +## Fn +[[Return to contents]](#Contents) + +## fkey +[[Return to contents]](#Contents) + +## new_method_with_receiver_type +[[Return to contents]](#Contents) + +## FnDecl +[[Return to contents]](#Contents) + +## fkey +[[Return to contents]](#Contents) + +## get_name +[[Return to contents]](#Contents) + +## modname +[[Return to contents]](#Contents) + +## new_method_with_receiver_type +[[Return to contents]](#Contents) + +## FnSignatureOpts +[[Return to contents]](#Contents) + +## FnTrace +[[Return to contents]](#Contents) + +## FnType +[[Return to contents]](#Contents) + +## FnTypeDecl +[[Return to contents]](#Contents) + +## ForCStmt +[[Return to contents]](#Contents) + +## ForInStmt +[[Return to contents]](#Contents) + +## ForStmt +[[Return to contents]](#Contents) + +## GenericInst +[[Return to contents]](#Contents) + +## GetEmbedsOptions +[[Return to contents]](#Contents) + +## GlobalDecl +[[Return to contents]](#Contents) + +## GlobalField +[[Return to contents]](#Contents) + +## GoExpr +[[Return to contents]](#Contents) + +## GotoLabel +[[Return to contents]](#Contents) + +## GotoStmt +[[Return to contents]](#Contents) + +## HashStmt +[[Return to contents]](#Contents) + +## Ident +[[Return to contents]](#Contents) + +## full_name +[[Return to contents]](#Contents) + +## is_auto_heap +[[Return to contents]](#Contents) + +## is_mut +[[Return to contents]](#Contents) + +## var_info +[[Return to contents]](#Contents) + +## IdentFn +[[Return to contents]](#Contents) + +## IdentVar +[[Return to contents]](#Contents) + +## IfBranch +[[Return to contents]](#Contents) + +## IfExpr +[[Return to contents]](#Contents) + +## IfGuardExpr +[[Return to contents]](#Contents) + +## IfGuardVar +[[Return to contents]](#Contents) + +## Import +[[Return to contents]](#Contents) + +## ImportSymbol +[[Return to contents]](#Contents) + +## IndexExpr +[[Return to contents]](#Contents) + +## recursive_mapset_is_setter +[[Return to contents]](#Contents) + +## recursive_arraymap_set_is_setter +[[Return to contents]](#Contents) + +## InfixExpr +[[Return to contents]](#Contents) + +## IntegerLiteral +[[Return to contents]](#Contents) + +## Interface +[[Return to contents]](#Contents) + +## find_field +[[Return to contents]](#Contents) + +## find_method +[[Return to contents]](#Contents) + +## has_method +[[Return to contents]](#Contents) + +## defines_method +[[Return to contents]](#Contents) + +## get_methods +[[Return to contents]](#Contents) + +## InterfaceDecl +[[Return to contents]](#Contents) + +## InterfaceEmbedding +[[Return to contents]](#Contents) + +## IsRefType +[[Return to contents]](#Contents) + +## LambdaExpr +[[Return to contents]](#Contents) + +## Likely +[[Return to contents]](#Contents) + +## LockExpr +[[Return to contents]](#Contents) + +## Map +[[Return to contents]](#Contents) + +## MapInit +[[Return to contents]](#Contents) + +## MatchBranch +[[Return to contents]](#Contents) + +## MatchExpr +[[Return to contents]](#Contents) + +## Module +[[Return to contents]](#Contents) + +## MultiReturn +[[Return to contents]](#Contents) + +## Nil +[[Return to contents]](#Contents) + +## NodeError +[[Return to contents]](#Contents) + +## None +[[Return to contents]](#Contents) + +## OffsetOf +[[Return to contents]](#Contents) + +## OrExpr +[[Return to contents]](#Contents) + +## ParExpr +[[Return to contents]](#Contents) + +## Param +[[Return to contents]](#Contents) + +## specifier +[[Return to contents]](#Contents) + +## PostfixExpr +[[Return to contents]](#Contents) + +## PrefixExpr +[[Return to contents]](#Contents) + +## RangeExpr +[[Return to contents]](#Contents) + +## Return +[[Return to contents]](#Contents) + +## Scope +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## find +[[Return to contents]](#Contents) + +## find_struct_field +[[Return to contents]](#Contents) + +## find_var +[[Return to contents]](#Contents) + +## find_global +[[Return to contents]](#Contents) + +## find_const +[[Return to contents]](#Contents) + +## known_var +[[Return to contents]](#Contents) + +## known_global +[[Return to contents]](#Contents) + +## known_const +[[Return to contents]](#Contents) + +## update_var_type +[[Return to contents]](#Contents) + +## update_ct_var_kind +[[Return to contents]](#Contents) + +## update_smartcasts +[[Return to contents]](#Contents) + +## register_struct_field +[[Return to contents]](#Contents) + +## register +[[Return to contents]](#Contents) + +## innermost +[[Return to contents]](#Contents) + +## get_all_vars +[[Return to contents]](#Contents) + +## contains +[[Return to contents]](#Contents) + +## has_inherited_vars +[[Return to contents]](#Contents) + +## is_inherited_var +[[Return to contents]](#Contents) + +## show +[[Return to contents]](#Contents) + +## mark_var_as_used +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ScopeStructField +[[Return to contents]](#Contents) + +## SelectBranch +[[Return to contents]](#Contents) + +## SelectExpr +[[Return to contents]](#Contents) + +## SelectorExpr +[[Return to contents]](#Contents) + +## root_ident +[[Return to contents]](#Contents) + +## SemicolonStmt +[[Return to contents]](#Contents) + +## SizeOf +[[Return to contents]](#Contents) + +## SpawnExpr +[[Return to contents]](#Contents) + +## SqlExpr +[[Return to contents]](#Contents) + +## SqlStmt +[[Return to contents]](#Contents) + +## SqlStmtLine +[[Return to contents]](#Contents) + +## StringInterLiteral +[[Return to contents]](#Contents) + +## get_fspec_braces +[[Return to contents]](#Contents) + +## StringLiteral +[[Return to contents]](#Contents) + +## Struct +[[Return to contents]](#Contents) + +## is_empty_struct +[[Return to contents]](#Contents) + +## is_unresolved_generic +[[Return to contents]](#Contents) + +## find_field +[[Return to contents]](#Contents) + +## get_field +[[Return to contents]](#Contents) + +## StructDecl +[[Return to contents]](#Contents) + +## StructField +[[Return to contents]](#Contents) + +## equals +[[Return to contents]](#Contents) + +## StructInit +[[Return to contents]](#Contents) + +## StructInitField +[[Return to contents]](#Contents) + +## SumType +[[Return to contents]](#Contents) + +## find_sum_type_field +[[Return to contents]](#Contents) + +## SumTypeDecl +[[Return to contents]](#Contents) + +## Table +[[Return to contents]](#Contents) + +## add_placeholder_type +[[Return to contents]](#Contents) + +## array_cname +[[Return to contents]](#Contents) + +## array_fixed_cname +[[Return to contents]](#Contents) + +## array_fixed_name +[[Return to contents]](#Contents) + +## array_name +[[Return to contents]](#Contents) + +## bitsize_to_type +[[Return to contents]](#Contents) + +## chan_cname +[[Return to contents]](#Contents) + +## chan_name +[[Return to contents]](#Contents) + +## check_if_elements_need_unwrap +[[Return to contents]](#Contents) + +## clean_generics_type_str +[[Return to contents]](#Contents) + +## complete_interface_check +[[Return to contents]](#Contents) + +## convert_generic_static_type_name +[[Return to contents]](#Contents) + +## convert_generic_type +[[Return to contents]](#Contents) + +## dependent_names_in_expr +[[Return to contents]](#Contents) + +## dependent_names_in_stmt +[[Return to contents]](#Contents) + +## does_type_implement_interface +[[Return to contents]](#Contents) + +## final_sym +[[Return to contents]](#Contents) + +## final_type +[[Return to contents]](#Contents) + +## find_enum_field_val +[[Return to contents]](#Contents) + +## find_field +[[Return to contents]](#Contents) + +## find_field_from_embeds +[[Return to contents]](#Contents) + +## find_field_with_embeds +[[Return to contents]](#Contents) + +## find_fn +[[Return to contents]](#Contents) + +## find_method +[[Return to contents]](#Contents) + +## find_method_from_embeds +[[Return to contents]](#Contents) + +## find_method_with_embeds +[[Return to contents]](#Contents) + +## find_missing_variants +[[Return to contents]](#Contents) + +## find_or_register_array +[[Return to contents]](#Contents) + +## find_or_register_array_fixed +[[Return to contents]](#Contents) + +## find_or_register_array_with_dims +[[Return to contents]](#Contents) + +## find_or_register_chan +[[Return to contents]](#Contents) + +## find_or_register_fn_type +[[Return to contents]](#Contents) + +## find_or_register_map +[[Return to contents]](#Contents) + +## find_or_register_multi_return +[[Return to contents]](#Contents) + +## find_or_register_promise +[[Return to contents]](#Contents) + +## find_or_register_thread +[[Return to contents]](#Contents) + +## find_sym +[[Return to contents]](#Contents) + +## find_sym_and_type_idx +[[Return to contents]](#Contents) + +## find_type +[[Return to contents]](#Contents) + +## find_type_idx +[[Return to contents]](#Contents) + +## find_type_idx_fn_scoped +[[Return to contents]](#Contents) + +## fn_signature +[[Return to contents]](#Contents) + +## fn_signature_using_aliases +[[Return to contents]](#Contents) + +## fn_type_signature +[[Return to contents]](#Contents) + +## fn_type_source_signature +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## generic_insts_to_concrete +[[Return to contents]](#Contents) + +## generic_type_names +[[Return to contents]](#Contents) + +## get_anon_fn_name +[[Return to contents]](#Contents) + +## get_array_dims +[[Return to contents]](#Contents) + +## get_attrs +[[Return to contents]](#Contents) + +## get_embed_methods +[[Return to contents]](#Contents) + +## get_embeds +[[Return to contents]](#Contents) + +## get_enum_field_names +[[Return to contents]](#Contents) + +## get_enum_field_vals +[[Return to contents]](#Contents) + +## get_final_type_name +[[Return to contents]](#Contents) + +## get_generic_names +[[Return to contents]](#Contents) + +## get_trace_fn_name +[[Return to contents]](#Contents) + +## get_type_name +[[Return to contents]](#Contents) + +## get_veb_result_type_idx +[[Return to contents]](#Contents) + +## has_cflag +[[Return to contents]](#Contents) + +## has_deep_child_no_ref +[[Return to contents]](#Contents) + +## has_method +[[Return to contents]](#Contents) + +## is_interface_smartcast +[[Return to contents]](#Contents) + +## is_interface_var +[[Return to contents]](#Contents) + +## is_same_method +[[Return to contents]](#Contents) + +## is_sumtype_or_in_variant +[[Return to contents]](#Contents) + +## known_fn +[[Return to contents]](#Contents) + +## known_type +[[Return to contents]](#Contents) + +## known_type_idx +[[Return to contents]](#Contents) + +## known_type_names +[[Return to contents]](#Contents) + +## map_cname +[[Return to contents]](#Contents) + +## map_name +[[Return to contents]](#Contents) + +## panic +[[Return to contents]](#Contents) + +## parse_cflag +[[Return to contents]](#Contents) + +## promise_cname +[[Return to contents]](#Contents) + +## promise_name +[[Return to contents]](#Contents) + +## register_aggregate_method +[[Return to contents]](#Contents) + +## register_anon_struct +[[Return to contents]](#Contents) + +## register_anon_union +[[Return to contents]](#Contents) + +## register_builtin_type_symbols +[[Return to contents]](#Contents) + +## register_enum_decl +[[Return to contents]](#Contents) + +## register_fn +[[Return to contents]](#Contents) + +## register_fn_concrete_types +[[Return to contents]](#Contents) + +## register_fn_generic_types +[[Return to contents]](#Contents) + +## register_interface +[[Return to contents]](#Contents) + +## register_sumtype +[[Return to contents]](#Contents) + +## register_sym +[[Return to contents]](#Contents) + +## reset_parsing_type +[[Return to contents]](#Contents) + +## resolve_common_sumtype_fields +[[Return to contents]](#Contents) + +## resolve_init +[[Return to contents]](#Contents) + +## start_parsing_type +[[Return to contents]](#Contents) + +## stringify_anon_decl +[[Return to contents]](#Contents) + +## stringify_fn_decl +[[Return to contents]](#Contents) + +## struct_fields +[[Return to contents]](#Contents) + +## struct_has_field +[[Return to contents]](#Contents) + +## sumtype_has_variant +[[Return to contents]](#Contents) + +## sym +[[Return to contents]](#Contents) + +## sym_by_idx +[[Return to contents]](#Contents) + +## thread_cname +[[Return to contents]](#Contents) + +## thread_name +[[Return to contents]](#Contents) + +## type_is_for_pointer_arithmetic +[[Return to contents]](#Contents) + +## type_kind +[[Return to contents]](#Contents) + +## type_size +[[Return to contents]](#Contents) + +## type_str +[[Return to contents]](#Contents) + +## type_to_code +[[Return to contents]](#Contents) + +## type_to_str +[[Return to contents]](#Contents) + +## type_to_str_using_aliases +[[Return to contents]](#Contents) + +## unalias_num_type +[[Return to contents]](#Contents) + +## unaliased_type +[[Return to contents]](#Contents) + +## unwrap_generic_type +[[Return to contents]](#Contents) + +## unwrap_generic_type_ex +[[Return to contents]](#Contents) + +## value_type +[[Return to contents]](#Contents) + +## Thread +[[Return to contents]](#Contents) + +## TypeNode +[[Return to contents]](#Contents) + +## TypeOf +[[Return to contents]](#Contents) + +## TypeSymbol +[[Return to contents]](#Contents) + +## array_fixed_info +[[Return to contents]](#Contents) + +## array_info +[[Return to contents]](#Contents) + +## chan_info +[[Return to contents]](#Contents) + +## dbg +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## embed_name +[[Return to contents]](#Contents) + +## enum_info +[[Return to contents]](#Contents) + +## find_field +[[Return to contents]](#Contents) + +## find_method +[[Return to contents]](#Contents) + +## find_method_with_generic_parent +[[Return to contents]](#Contents) + +## get_methods +[[Return to contents]](#Contents) + +## has_field +[[Return to contents]](#Contents) + +## has_method +[[Return to contents]](#Contents) + +## has_method_with_generic_parent +[[Return to contents]](#Contents) + +## is_array_fixed +[[Return to contents]](#Contents) + +## is_array_fixed_ret +[[Return to contents]](#Contents) + +## is_bool +[[Return to contents]](#Contents) + +## is_builtin +[[Return to contents]](#Contents) + +## is_c_struct +[[Return to contents]](#Contents) + +## is_empty_struct_array +[[Return to contents]](#Contents) + +## is_float +[[Return to contents]](#Contents) + +## is_heap +[[Return to contents]](#Contents) + +## is_int +[[Return to contents]](#Contents) + +## is_js_compatible +[[Return to contents]](#Contents) + +## is_number +[[Return to contents]](#Contents) + +## is_pointer +[[Return to contents]](#Contents) + +## is_primitive +[[Return to contents]](#Contents) + +## is_primitive_fixed_array +[[Return to contents]](#Contents) + +## is_string +[[Return to contents]](#Contents) + +## map_info +[[Return to contents]](#Contents) + +## mr_info +[[Return to contents]](#Contents) + +## nr_dims +[[Return to contents]](#Contents) + +## register_method +[[Return to contents]](#Contents) + +## scoped_cname +[[Return to contents]](#Contents) + +## scoped_name +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## str_method_info +[[Return to contents]](#Contents) + +## struct_info +[[Return to contents]](#Contents) + +## sumtype_info +[[Return to contents]](#Contents) + +## symbol_name_except_generic +[[Return to contents]](#Contents) + +## thread_info +[[Return to contents]](#Contents) + +## update_method +[[Return to contents]](#Contents) + +## UnknownTypeInfo +[[Return to contents]](#Contents) + +## UnsafeExpr +[[Return to contents]](#Contents) + +## UsedFeatures +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## Var +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.ast.walker.md b/vdocs/v.ast.walker.md new file mode 100644 index 00000000..338a65ca --- /dev/null +++ b/vdocs/v.ast.walker.md @@ -0,0 +1,28 @@ +# module v.ast.walker + + +## Contents +- [inspect](#inspect) +- [walk](#walk) +- [Visitor](#Visitor) +- [Inspector](#Inspector) + - [visit](#visit) +- [InspectorFn](#InspectorFn) + +## inspect +[[Return to contents]](#Contents) + +## walk +[[Return to contents]](#Contents) + +## Visitor +[[Return to contents]](#Contents) + +## Inspector +## visit +[[Return to contents]](#Contents) + +## InspectorFn +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.builder.cbuilder.md b/vdocs/v.builder.cbuilder.md new file mode 100644 index 00000000..ab2758a4 --- /dev/null +++ b/vdocs/v.builder.cbuilder.md @@ -0,0 +1,22 @@ +# module v.builder.cbuilder + + +## Contents +- [build_c](#build_c) +- [compile_c](#compile_c) +- [gen_c](#gen_c) +- [start](#start) + +## build_c +[[Return to contents]](#Contents) + +## compile_c +[[Return to contents]](#Contents) + +## gen_c +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.builder.golangbuilder.md b/vdocs/v.builder.golangbuilder.md new file mode 100644 index 00000000..a0716fa2 --- /dev/null +++ b/vdocs/v.builder.golangbuilder.md @@ -0,0 +1,18 @@ +# module v.builder.golangbuilder + + +## Contents +- [build_golang](#build_golang) +- [compile_golang](#compile_golang) +- [start](#start) + +## build_golang +[[Return to contents]](#Contents) + +## compile_golang +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.builder.interpreterbuilder.md b/vdocs/v.builder.interpreterbuilder.md new file mode 100644 index 00000000..9301242f --- /dev/null +++ b/vdocs/v.builder.interpreterbuilder.md @@ -0,0 +1,14 @@ +# module v.builder.interpreterbuilder + + +## Contents +- [interpret_v](#interpret_v) +- [start](#start) + +## interpret_v +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.builder.jsbuilder.md b/vdocs/v.builder.jsbuilder.md new file mode 100644 index 00000000..1d068e3d --- /dev/null +++ b/vdocs/v.builder.jsbuilder.md @@ -0,0 +1,22 @@ +# module v.builder.jsbuilder + + +## Contents +- [build_js](#build_js) +- [compile_js](#compile_js) +- [gen_js](#gen_js) +- [start](#start) + +## build_js +[[Return to contents]](#Contents) + +## compile_js +[[Return to contents]](#Contents) + +## gen_js +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.builder.md b/vdocs/v.builder.md new file mode 100644 index 00000000..beefdf3e --- /dev/null +++ b/vdocs/v.builder.md @@ -0,0 +1,158 @@ +# module v.builder + + +## Contents +- [compile](#compile) +- [module_path](#module_path) +- [new_builder](#new_builder) +- [verror](#verror) +- [FnBackend](#FnBackend) +- [CC](#CC) +- [Builder](#Builder) + - [cc](#cc) + - [dump_c_options](#dump_c_options) + - [dump_defines](#dump_defines) + - [dump_files](#dump_files) + - [dump_modules](#dump_modules) + - [error_with_pos](#error_with_pos) + - [find_invalidated_modules_by_files](#find_invalidated_modules_by_files) + - [find_module_path](#find_module_path) + - [front_and_middle_stages](#front_and_middle_stages) + - [front_stages](#front_stages) + - [get_builtin_files](#get_builtin_files) + - [get_compile_args](#get_compile_args) + - [get_linker_args](#get_linker_args) + - [get_user_files](#get_user_files) + - [get_vtmp_filename](#get_vtmp_filename) + - [import_graph](#import_graph) + - [info](#info) + - [interpret_text](#interpret_text) + - [log](#log) + - [middle_stages](#middle_stages) + - [parse_imports](#parse_imports) + - [print_warnings_and_errors](#print_warnings_and_errors) + - [quote_compiler_name](#quote_compiler_name) + - [rebuild](#rebuild) + - [rebuild_modules](#rebuild_modules) + - [resolve_deps](#resolve_deps) + - [set_module_lookup_paths](#set_module_lookup_paths) + - [should_rebuild](#should_rebuild) + - [show_total_warns_and_errors_stats](#show_total_warns_and_errors_stats) + - [v_files_from_dir](#v_files_from_dir) +- [CcompilerOptions](#CcompilerOptions) + +## compile +[[Return to contents]](#Contents) + +## module_path +[[Return to contents]](#Contents) + +## new_builder +[[Return to contents]](#Contents) + +## verror +[[Return to contents]](#Contents) + +## FnBackend +[[Return to contents]](#Contents) + +## CC +[[Return to contents]](#Contents) + +## Builder +[[Return to contents]](#Contents) + +## cc +[[Return to contents]](#Contents) + +## dump_c_options +[[Return to contents]](#Contents) + +## dump_defines +[[Return to contents]](#Contents) + +## dump_files +[[Return to contents]](#Contents) + +## dump_modules +[[Return to contents]](#Contents) + +## error_with_pos +[[Return to contents]](#Contents) + +## find_invalidated_modules_by_files +[[Return to contents]](#Contents) + +## find_module_path +[[Return to contents]](#Contents) + +## front_and_middle_stages +[[Return to contents]](#Contents) + +## front_stages +[[Return to contents]](#Contents) + +## get_builtin_files +[[Return to contents]](#Contents) + +## get_compile_args +[[Return to contents]](#Contents) + +## get_linker_args +[[Return to contents]](#Contents) + +## get_user_files +[[Return to contents]](#Contents) + +## get_vtmp_filename +[[Return to contents]](#Contents) + +## import_graph +[[Return to contents]](#Contents) + +## info +[[Return to contents]](#Contents) + +## interpret_text +[[Return to contents]](#Contents) + +## log +[[Return to contents]](#Contents) + +## middle_stages +[[Return to contents]](#Contents) + +## parse_imports +[[Return to contents]](#Contents) + +## print_warnings_and_errors +[[Return to contents]](#Contents) + +## quote_compiler_name +[[Return to contents]](#Contents) + +## rebuild +[[Return to contents]](#Contents) + +## rebuild_modules +[[Return to contents]](#Contents) + +## resolve_deps +[[Return to contents]](#Contents) + +## set_module_lookup_paths +[[Return to contents]](#Contents) + +## should_rebuild +[[Return to contents]](#Contents) + +## show_total_warns_and_errors_stats +[[Return to contents]](#Contents) + +## v_files_from_dir +[[Return to contents]](#Contents) + +## CcompilerOptions +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.builder.nativebuilder.md b/vdocs/v.builder.nativebuilder.md new file mode 100644 index 00000000..4c5a8cd2 --- /dev/null +++ b/vdocs/v.builder.nativebuilder.md @@ -0,0 +1,18 @@ +# module v.builder.nativebuilder + + +## Contents +- [build_native](#build_native) +- [compile_native](#compile_native) +- [start](#start) + +## build_native +[[Return to contents]](#Contents) + +## compile_native +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.builder.wasmbuilder.md b/vdocs/v.builder.wasmbuilder.md new file mode 100644 index 00000000..34e69294 --- /dev/null +++ b/vdocs/v.builder.wasmbuilder.md @@ -0,0 +1,18 @@ +# module v.builder.wasmbuilder + + +## Contents +- [build_wasm](#build_wasm) +- [compile_wasm](#compile_wasm) +- [start](#start) + +## build_wasm +[[Return to contents]](#Contents) + +## compile_wasm +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.callgraph.md b/vdocs/v.callgraph.md new file mode 100644 index 00000000..865ac334 --- /dev/null +++ b/vdocs/v.callgraph.md @@ -0,0 +1,10 @@ +# module v.callgraph + + +## Contents +- [show](#show) + +## show +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.cflag.md b/vdocs/v.cflag.md new file mode 100644 index 00000000..1ecc9cb1 --- /dev/null +++ b/vdocs/v.cflag.md @@ -0,0 +1,52 @@ +# module v.cflag + + +## Contents +- [[]CFlag](#[]CFlag) + - [c_options_before_target_msvc](#c_options_before_target_msvc) + - [c_options_after_target_msvc](#c_options_after_target_msvc) + - [c_options_before_target](#c_options_before_target) + - [c_options_after_target](#c_options_after_target) + - [c_options_without_object_files](#c_options_without_object_files) + - [c_options_only_object_files](#c_options_only_object_files) + - [defines_others_libs](#defines_others_libs) +- [CFlag](#CFlag) + - [str](#str) + - [eval](#eval) + - [format](#format) + +## []CFlag +## c_options_before_target_msvc +[[Return to contents]](#Contents) + +## c_options_after_target_msvc +[[Return to contents]](#Contents) + +## c_options_before_target +[[Return to contents]](#Contents) + +## c_options_after_target +[[Return to contents]](#Contents) + +## c_options_without_object_files +[[Return to contents]](#Contents) + +## c_options_only_object_files +[[Return to contents]](#Contents) + +## defines_others_libs +[[Return to contents]](#Contents) + +## CFlag +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## eval +[[Return to contents]](#Contents) + +## format +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:55 diff --git a/vdocs/v.checker.md b/vdocs/v.checker.md new file mode 100644 index 00000000..1c1dfb16 --- /dev/null +++ b/vdocs/v.checker.md @@ -0,0 +1,70 @@ +# module v.checker + + +## Contents +- [Constants](#Constants) +- [new_checker](#new_checker) +- [Checker](#Checker) + - [change_current_file](#change_current_file) + - [check](#check) + - [check_files](#check_files) + - [check_scope_vars](#check_scope_vars) + - [expr](#expr) + - [lambda_expr](#lambda_expr) + - [lambda_expr_fix_type_of_param](#lambda_expr_fix_type_of_param) + - [support_lambda_expr_in_sort](#support_lambda_expr_in_sort) + - [support_lambda_expr_one_param](#support_lambda_expr_one_param) + - [update_unresolved_fixed_sizes](#update_unresolved_fixed_sizes) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## new_checker +[[Return to contents]](#Contents) + +## Checker +[[Return to contents]](#Contents) + +## change_current_file +[[Return to contents]](#Contents) + +## check +[[Return to contents]](#Contents) + +## check_files +[[Return to contents]](#Contents) + +## check_scope_vars +[[Return to contents]](#Contents) + +## expr +[[Return to contents]](#Contents) + +## lambda_expr +[[Return to contents]](#Contents) + +## lambda_expr_fix_type_of_param +[[Return to contents]](#Contents) + +## support_lambda_expr_in_sort +[[Return to contents]](#Contents) + +## support_lambda_expr_one_param +[[Return to contents]](#Contents) + +## update_unresolved_fixed_sizes +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.debug.md b/vdocs/v.debug.md new file mode 100644 index 00000000..de07c887 --- /dev/null +++ b/vdocs/v.debug.md @@ -0,0 +1,52 @@ +# module v.debug + + +## Contents +- [add_after_call](#add_after_call) +- [add_before_call](#add_before_call) +- [callstack](#callstack) +- [dump_callstack](#dump_callstack) +- [remove_after_call](#remove_after_call) +- [remove_before_call](#remove_before_call) +- [Debugger](#Debugger) + - [interact](#interact) +- [DebugContextInfo](#DebugContextInfo) +- [DebugContextVar](#DebugContextVar) +- [FnTrace](#FnTrace) +- [TraceHook](#TraceHook) + +## add_after_call +[[Return to contents]](#Contents) + +## add_before_call +[[Return to contents]](#Contents) + +## callstack +[[Return to contents]](#Contents) + +## dump_callstack +[[Return to contents]](#Contents) + +## remove_after_call +[[Return to contents]](#Contents) + +## remove_before_call +[[Return to contents]](#Contents) + +## Debugger +## interact +[[Return to contents]](#Contents) + +## DebugContextInfo +[[Return to contents]](#Contents) + +## DebugContextVar +[[Return to contents]](#Contents) + +## FnTrace +[[Return to contents]](#Contents) + +## TraceHook +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.depgraph.md b/vdocs/v.depgraph.md new file mode 100644 index 00000000..d546ff78 --- /dev/null +++ b/vdocs/v.depgraph.md @@ -0,0 +1,72 @@ +# module v.depgraph + + +## Contents +- [new_dep_graph](#new_dep_graph) +- [new_ordered_dependency_map](#new_ordered_dependency_map) +- [show](#show) +- [OrderedDepMap](#OrderedDepMap) + - [set](#set) + - [add](#add) + - [get](#get) + - [delete](#delete) + - [apply_diff](#apply_diff) + - [size](#size) +- [DepGraph](#DepGraph) + - [add](#add) + - [add_with_value](#add_with_value) + - [resolve](#resolve) + - [last_node](#last_node) + - [display](#display) + - [display_cycles](#display_cycles) + +## new_dep_graph +[[Return to contents]](#Contents) + +## new_ordered_dependency_map +[[Return to contents]](#Contents) + +## show +[[Return to contents]](#Contents) + +## OrderedDepMap +## set +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## delete +[[Return to contents]](#Contents) + +## apply_diff +[[Return to contents]](#Contents) + +## size +[[Return to contents]](#Contents) + +## DepGraph +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add_with_value +[[Return to contents]](#Contents) + +## resolve +[[Return to contents]](#Contents) + +## last_node +[[Return to contents]](#Contents) + +## display +[[Return to contents]](#Contents) + +## display_cycles +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.dotgraph.md b/vdocs/v.dotgraph.md new file mode 100644 index 00000000..7fbfcc20 --- /dev/null +++ b/vdocs/v.dotgraph.md @@ -0,0 +1,50 @@ +# module v.dotgraph + + +## Contents +- [new](#new) +- [node_name](#node_name) +- [start_digraph](#start_digraph) +- [FnLabel2NodeName](#FnLabel2NodeName) +- [DotGraph](#DotGraph) + - [writeln](#writeln) + - [finish](#finish) + - [new_node](#new_node) + - [new_edge](#new_edge) +- [NewEdgeConfig](#NewEdgeConfig) +- [NewNodeConfig](#NewNodeConfig) + +## new +[[Return to contents]](#Contents) + +## node_name +[[Return to contents]](#Contents) + +## start_digraph +[[Return to contents]](#Contents) + +## FnLabel2NodeName +[[Return to contents]](#Contents) + +## DotGraph +[[Return to contents]](#Contents) + +## writeln +[[Return to contents]](#Contents) + +## finish +[[Return to contents]](#Contents) + +## new_node +[[Return to contents]](#Contents) + +## new_edge +[[Return to contents]](#Contents) + +## NewEdgeConfig +[[Return to contents]](#Contents) + +## NewNodeConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.embed_file.md b/vdocs/v.embed_file.md new file mode 100644 index 00000000..aa3ae58d --- /dev/null +++ b/vdocs/v.embed_file.md @@ -0,0 +1,46 @@ +# module v.embed_file + + +## Contents +- [find_index_entry_by_path](#find_index_entry_by_path) +- [register_decoder](#register_decoder) +- [Decoder](#Decoder) +- [EmbedFileData](#EmbedFileData) + - [str](#str) + - [free](#free) + - [to_string](#to_string) + - [to_bytes](#to_bytes) + - [data](#data) +- [EmbedFileIndexEntry](#EmbedFileIndexEntry) + +## find_index_entry_by_path +[[Return to contents]](#Contents) + +## register_decoder +[[Return to contents]](#Contents) + +## Decoder +[[Return to contents]](#Contents) + +## EmbedFileData +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## to_string +[[Return to contents]](#Contents) + +## to_bytes +[[Return to contents]](#Contents) + +## data +[[Return to contents]](#Contents) + +## EmbedFileIndexEntry +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.errors.md b/vdocs/v.errors.md new file mode 100644 index 00000000..b020dcea --- /dev/null +++ b/vdocs/v.errors.md @@ -0,0 +1,26 @@ +# module v.errors + + +## Contents +- [Reporter](#Reporter) +- [CompilerMessage](#CompilerMessage) +- [Error](#Error) +- [Notice](#Notice) +- [Warning](#Warning) + +## Reporter +[[Return to contents]](#Contents) + +## CompilerMessage +[[Return to contents]](#Contents) + +## Error +[[Return to contents]](#Contents) + +## Notice +[[Return to contents]](#Contents) + +## Warning +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.eval.md b/vdocs/v.eval.md new file mode 100644 index 00000000..5fe415d0 --- /dev/null +++ b/vdocs/v.eval.md @@ -0,0 +1,116 @@ +# module v.eval + + +## Contents +- [create](#create) +- [new_eval](#new_eval) +- [Object](#Object) + - [string](#string) + - [int_val](#int_val) + - [float_val](#float_val) +- [Array](#Array) +- [Eval](#Eval) + - [add](#add) + - [close_scope](#close_scope) + - [comptime_cond](#comptime_cond) + - [eval](#eval) + - [expr](#expr) + - [open_scope](#open_scope) + - [register_symbol](#register_symbol) + - [register_symbol_stmts](#register_symbol_stmts) + - [register_symbols](#register_symbols) + - [run_func](#run_func) + - [set](#set) + - [stmt](#stmt) + - [stmts](#stmts) +- [EvalTrace](#EvalTrace) +- [FixedArray](#FixedArray) +- [Float](#Float) +- [Int](#Int) +- [Ptr](#Ptr) +- [Uint](#Uint) +- [Var](#Var) + +## create +[[Return to contents]](#Contents) + +## new_eval +[[Return to contents]](#Contents) + +## Object +## string +[[Return to contents]](#Contents) + +## int_val +[[Return to contents]](#Contents) + +## float_val +[[Return to contents]](#Contents) + +## Array +[[Return to contents]](#Contents) + +## Eval +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## close_scope +[[Return to contents]](#Contents) + +## comptime_cond +[[Return to contents]](#Contents) + +## eval +[[Return to contents]](#Contents) + +## expr +[[Return to contents]](#Contents) + +## open_scope +[[Return to contents]](#Contents) + +## register_symbol +[[Return to contents]](#Contents) + +## register_symbol_stmts +[[Return to contents]](#Contents) + +## register_symbols +[[Return to contents]](#Contents) + +## run_func +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## stmt +[[Return to contents]](#Contents) + +## stmts +[[Return to contents]](#Contents) + +## EvalTrace +[[Return to contents]](#Contents) + +## FixedArray +[[Return to contents]](#Contents) + +## Float +[[Return to contents]](#Contents) + +## Int +[[Return to contents]](#Contents) + +## Ptr +[[Return to contents]](#Contents) + +## Uint +[[Return to contents]](#Contents) + +## Var +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.fmt.md b/vdocs/v.fmt.md new file mode 100644 index 00000000..83a1b1b4 --- /dev/null +++ b/vdocs/v.fmt.md @@ -0,0 +1,438 @@ +# module v.fmt + + +## Contents +- [fmt](#fmt) +- [CommentsLevel](#CommentsLevel) +- [AttrsOptions](#AttrsOptions) +- [CommentsOptions](#CommentsOptions) +- [Fmt](#Fmt) + - [alias_type_decl](#alias_type_decl) + - [anon_fn](#anon_fn) + - [array_decompose](#array_decompose) + - [array_init](#array_init) + - [as_cast](#as_cast) + - [assert_stmt](#assert_stmt) + - [assign_stmt](#assign_stmt) + - [assoc](#assoc) + - [at_expr](#at_expr) + - [attrs](#attrs) + - [block](#block) + - [branch_stmt](#branch_stmt) + - [calculate_alignment](#calculate_alignment) + - [call_args](#call_args) + - [call_expr](#call_expr) + - [cast_expr](#cast_expr) + - [chan_init](#chan_init) + - [char_literal](#char_literal) + - [comment](#comment) + - [comments](#comments) + - [comments_after_last_field](#comments_after_last_field) + - [comments_before_field](#comments_before_field) + - [comptime_call](#comptime_call) + - [comptime_for](#comptime_for) + - [comptime_selector](#comptime_selector) + - [concat_expr](#concat_expr) + - [const_decl](#const_decl) + - [debugger_stmt](#debugger_stmt) + - [dump_expr](#dump_expr) + - [enum_decl](#enum_decl) + - [enum_val](#enum_val) + - [expr](#expr) + - [expr_stmt](#expr_stmt) + - [fn_decl](#fn_decl) + - [fn_type_decl](#fn_type_decl) + - [for_c_stmt](#for_c_stmt) + - [for_in_stmt](#for_in_stmt) + - [for_stmt](#for_stmt) + - [get_source_lines](#get_source_lines) + - [global_decl](#global_decl) + - [go_expr](#go_expr) + - [goto_label](#goto_label) + - [goto_stmt](#goto_stmt) + - [hash_stmt](#hash_stmt) + - [ident](#ident) + - [if_expr](#if_expr) + - [if_guard_expr](#if_guard_expr) + - [imp_stmt_str](#imp_stmt_str) + - [import_comments](#import_comments) + - [imports](#imports) + - [index_expr](#index_expr) + - [infix_expr](#infix_expr) + - [interface_decl](#interface_decl) + - [interface_field](#interface_field) + - [interface_method](#interface_method) + - [is_ref_type](#is_ref_type) + - [likely](#likely) + - [lock_expr](#lock_expr) + - [map_init](#map_init) + - [mark_import_as_used](#mark_import_as_used) + - [mark_types_import_as_used](#mark_types_import_as_used) + - [match_expr](#match_expr) + - [module_stmt](#module_stmt) + - [no_cur_mod](#no_cur_mod) + - [node_str](#node_str) + - [offset_of](#offset_of) + - [or_expr](#or_expr) + - [par_expr](#par_expr) + - [postfix_expr](#postfix_expr) + - [prefix_expr](#prefix_expr) + - [process_file_imports](#process_file_imports) + - [range_expr](#range_expr) + - [remove_new_line](#remove_new_line) + - [return_stmt](#return_stmt) + - [select_expr](#select_expr) + - [selector_expr](#selector_expr) + - [set_current_module_name](#set_current_module_name) + - [short_module](#short_module) + - [single_line_attrs](#single_line_attrs) + - [size_of](#size_of) + - [spawn_expr](#spawn_expr) + - [sql_expr](#sql_expr) + - [sql_stmt](#sql_stmt) + - [sql_stmt_line](#sql_stmt_line) + - [stmt](#stmt) + - [stmts](#stmts) + - [string_inter_literal](#string_inter_literal) + - [string_literal](#string_literal) + - [struct_decl](#struct_decl) + - [struct_init](#struct_init) + - [sum_type_decl](#sum_type_decl) + - [type_decl](#type_decl) + - [type_expr](#type_expr) + - [type_of](#type_of) + - [unsafe_expr](#unsafe_expr) + - [vfmt_off](#vfmt_off) + - [vfmt_on](#vfmt_on) + - [wrap_infix](#wrap_infix) + - [wrap_long_line](#wrap_long_line) + - [write](#write) + - [writeln](#writeln) +- [FmtOptions](#FmtOptions) +- [RemoveNewLineConfig](#RemoveNewLineConfig) + +## fmt +[[Return to contents]](#Contents) + +## CommentsLevel +[[Return to contents]](#Contents) + +## AttrsOptions +[[Return to contents]](#Contents) + +## CommentsOptions +[[Return to contents]](#Contents) + +## Fmt +[[Return to contents]](#Contents) + +## alias_type_decl +[[Return to contents]](#Contents) + +## anon_fn +[[Return to contents]](#Contents) + +## array_decompose +[[Return to contents]](#Contents) + +## array_init +[[Return to contents]](#Contents) + +## as_cast +[[Return to contents]](#Contents) + +## assert_stmt +[[Return to contents]](#Contents) + +## assign_stmt +[[Return to contents]](#Contents) + +## assoc +[[Return to contents]](#Contents) + +## at_expr +[[Return to contents]](#Contents) + +## attrs +[[Return to contents]](#Contents) + +## block +[[Return to contents]](#Contents) + +## branch_stmt +[[Return to contents]](#Contents) + +## calculate_alignment +[[Return to contents]](#Contents) + +## call_args +[[Return to contents]](#Contents) + +## call_expr +[[Return to contents]](#Contents) + +## cast_expr +[[Return to contents]](#Contents) + +## chan_init +[[Return to contents]](#Contents) + +## char_literal +[[Return to contents]](#Contents) + +## comment +[[Return to contents]](#Contents) + +## comments +[[Return to contents]](#Contents) + +## comments_after_last_field +[[Return to contents]](#Contents) + +## comments_before_field +[[Return to contents]](#Contents) + +## comptime_call +[[Return to contents]](#Contents) + +## comptime_for +[[Return to contents]](#Contents) + +## comptime_selector +[[Return to contents]](#Contents) + +## concat_expr +[[Return to contents]](#Contents) + +## const_decl +[[Return to contents]](#Contents) + +## debugger_stmt +[[Return to contents]](#Contents) + +## dump_expr +[[Return to contents]](#Contents) + +## enum_decl +[[Return to contents]](#Contents) + +## enum_val +[[Return to contents]](#Contents) + +## expr +[[Return to contents]](#Contents) + +## expr_stmt +[[Return to contents]](#Contents) + +## fn_decl +[[Return to contents]](#Contents) + +## fn_type_decl +[[Return to contents]](#Contents) + +## for_c_stmt +[[Return to contents]](#Contents) + +## for_in_stmt +[[Return to contents]](#Contents) + +## for_stmt +[[Return to contents]](#Contents) + +## get_source_lines +[[Return to contents]](#Contents) + +## global_decl +[[Return to contents]](#Contents) + +## go_expr +[[Return to contents]](#Contents) + +## goto_label +[[Return to contents]](#Contents) + +## goto_stmt +[[Return to contents]](#Contents) + +## hash_stmt +[[Return to contents]](#Contents) + +## ident +[[Return to contents]](#Contents) + +## if_expr +[[Return to contents]](#Contents) + +## if_guard_expr +[[Return to contents]](#Contents) + +## imp_stmt_str +[[Return to contents]](#Contents) + +## import_comments +[[Return to contents]](#Contents) + +## imports +[[Return to contents]](#Contents) + +## index_expr +[[Return to contents]](#Contents) + +## infix_expr +[[Return to contents]](#Contents) + +## interface_decl +[[Return to contents]](#Contents) + +## interface_field +[[Return to contents]](#Contents) + +## interface_method +[[Return to contents]](#Contents) + +## is_ref_type +[[Return to contents]](#Contents) + +## likely +[[Return to contents]](#Contents) + +## lock_expr +[[Return to contents]](#Contents) + +## map_init +[[Return to contents]](#Contents) + +## mark_import_as_used +[[Return to contents]](#Contents) + +## mark_types_import_as_used +[[Return to contents]](#Contents) + +## match_expr +[[Return to contents]](#Contents) + +## module_stmt +[[Return to contents]](#Contents) + +## no_cur_mod +[[Return to contents]](#Contents) + +## node_str +[[Return to contents]](#Contents) + +## offset_of +[[Return to contents]](#Contents) + +## or_expr +[[Return to contents]](#Contents) + +## par_expr +[[Return to contents]](#Contents) + +## postfix_expr +[[Return to contents]](#Contents) + +## prefix_expr +[[Return to contents]](#Contents) + +## process_file_imports +[[Return to contents]](#Contents) + +## range_expr +[[Return to contents]](#Contents) + +## remove_new_line +[[Return to contents]](#Contents) + +## return_stmt +[[Return to contents]](#Contents) + +## select_expr +[[Return to contents]](#Contents) + +## selector_expr +[[Return to contents]](#Contents) + +## set_current_module_name +[[Return to contents]](#Contents) + +## short_module +[[Return to contents]](#Contents) + +## single_line_attrs +[[Return to contents]](#Contents) + +## size_of +[[Return to contents]](#Contents) + +## spawn_expr +[[Return to contents]](#Contents) + +## sql_expr +[[Return to contents]](#Contents) + +## sql_stmt +[[Return to contents]](#Contents) + +## sql_stmt_line +[[Return to contents]](#Contents) + +## stmt +[[Return to contents]](#Contents) + +## stmts +[[Return to contents]](#Contents) + +## string_inter_literal +[[Return to contents]](#Contents) + +## string_literal +[[Return to contents]](#Contents) + +## struct_decl +[[Return to contents]](#Contents) + +## struct_init +[[Return to contents]](#Contents) + +## sum_type_decl +[[Return to contents]](#Contents) + +## type_decl +[[Return to contents]](#Contents) + +## type_expr +[[Return to contents]](#Contents) + +## type_of +[[Return to contents]](#Contents) + +## unsafe_expr +[[Return to contents]](#Contents) + +## vfmt_off +[[Return to contents]](#Contents) + +## vfmt_on +[[Return to contents]](#Contents) + +## wrap_infix +[[Return to contents]](#Contents) + +## wrap_long_line +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## writeln +[[Return to contents]](#Contents) + +## FmtOptions +[[Return to contents]](#Contents) + +## RemoveNewLineConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.c.md b/vdocs/v.gen.c.md new file mode 100644 index 00000000..d6531e7c --- /dev/null +++ b/vdocs/v.gen.c.md @@ -0,0 +1,174 @@ +# module v.gen.c + + +## Contents +- [Constants](#Constants) +- [fix_reset_dbg_line](#fix_reset_dbg_line) +- [gen](#gen) +- [get_guarded_include_text](#get_guarded_include_text) +- [Gen](#Gen) + - [contains_ptr](#contains_ptr) + - [current_tmp_var](#current_tmp_var) + - [filter_only_matching_fn_names](#filter_only_matching_fn_names) + - [finish](#finish) + - [free_builders](#free_builders) + - [gen_c_android_sokol_main](#gen_c_android_sokol_main) + - [gen_c_main](#gen_c_main) + - [gen_c_main_footer](#gen_c_main_footer) + - [gen_c_main_for_tests](#gen_c_main_for_tests) + - [gen_c_main_profile_hook](#gen_c_main_profile_hook) + - [gen_c_main_trace_calls_hook](#gen_c_main_trace_calls_hook) + - [gen_failing_error_propagation_for_test_fn](#gen_failing_error_propagation_for_test_fn) + - [gen_failing_return_error_for_test_fn](#gen_failing_return_error_for_test_fn) + - [gen_file](#gen_file) + - [gen_vprint_profile_stats](#gen_vprint_profile_stats) + - [get_array_depth](#get_array_depth) + - [get_sumtype_variant_name](#get_sumtype_variant_name) + - [get_sumtype_variant_type_name](#get_sumtype_variant_type_name) + - [hashes](#hashes) + - [init](#init) + - [new_global_tmp_var](#new_global_tmp_var) + - [new_tmp_declaration_name](#new_tmp_declaration_name) + - [new_tmp_var](#new_tmp_var) + - [reset_tmp_count](#reset_tmp_count) + - [ret_styp](#ret_styp) + - [write_alias_typesymbol_declaration](#write_alias_typesymbol_declaration) + - [write_array_fixed_return_types](#write_array_fixed_return_types) + - [write_fn_typesymbol_declaration](#write_fn_typesymbol_declaration) + - [write_interface_typedef](#write_interface_typedef) + - [write_interface_typesymbol_declaration](#write_interface_typesymbol_declaration) + - [write_multi_return_types](#write_multi_return_types) + - [write_tests_definitions](#write_tests_definitions) + - [write_typedef_types](#write_typedef_types) + - [write_typeof_functions](#write_typeof_functions) +- [GenOutput](#GenOutput) +- [ProfileCounterMeta](#ProfileCounterMeta) +- [TraceLastLinesParams](#TraceLastLinesParams) + +## Constants +[[Return to contents]](#Contents) + +## fix_reset_dbg_line +[[Return to contents]](#Contents) + +## gen +[[Return to contents]](#Contents) + +## get_guarded_include_text +[[Return to contents]](#Contents) + +## Gen +[[Return to contents]](#Contents) + +## contains_ptr +[[Return to contents]](#Contents) + +## current_tmp_var +[[Return to contents]](#Contents) + +## filter_only_matching_fn_names +[[Return to contents]](#Contents) + +## finish +[[Return to contents]](#Contents) + +## free_builders +[[Return to contents]](#Contents) + +## gen_c_android_sokol_main +[[Return to contents]](#Contents) + +## gen_c_main +[[Return to contents]](#Contents) + +## gen_c_main_footer +[[Return to contents]](#Contents) + +## gen_c_main_for_tests +[[Return to contents]](#Contents) + +## gen_c_main_profile_hook +[[Return to contents]](#Contents) + +## gen_c_main_trace_calls_hook +[[Return to contents]](#Contents) + +## gen_failing_error_propagation_for_test_fn +[[Return to contents]](#Contents) + +## gen_failing_return_error_for_test_fn +[[Return to contents]](#Contents) + +## gen_file +[[Return to contents]](#Contents) + +## gen_vprint_profile_stats +[[Return to contents]](#Contents) + +## get_array_depth +[[Return to contents]](#Contents) + +## get_sumtype_variant_name +[[Return to contents]](#Contents) + +## get_sumtype_variant_type_name +[[Return to contents]](#Contents) + +## hashes +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## new_global_tmp_var +[[Return to contents]](#Contents) + +## new_tmp_declaration_name +[[Return to contents]](#Contents) + +## new_tmp_var +[[Return to contents]](#Contents) + +## reset_tmp_count +[[Return to contents]](#Contents) + +## ret_styp +[[Return to contents]](#Contents) + +## write_alias_typesymbol_declaration +[[Return to contents]](#Contents) + +## write_array_fixed_return_types +[[Return to contents]](#Contents) + +## write_fn_typesymbol_declaration +[[Return to contents]](#Contents) + +## write_interface_typedef +[[Return to contents]](#Contents) + +## write_interface_typesymbol_declaration +[[Return to contents]](#Contents) + +## write_multi_return_types +[[Return to contents]](#Contents) + +## write_tests_definitions +[[Return to contents]](#Contents) + +## write_typedef_types +[[Return to contents]](#Contents) + +## write_typeof_functions +[[Return to contents]](#Contents) + +## GenOutput +[[Return to contents]](#Contents) + +## ProfileCounterMeta +[[Return to contents]](#Contents) + +## TraceLastLinesParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.golang.md b/vdocs/v.gen.golang.md new file mode 100644 index 00000000..240dcead --- /dev/null +++ b/vdocs/v.gen.golang.md @@ -0,0 +1,394 @@ +# module v.gen.golang + + +## Contents +- [gen](#gen) +- [AttrsOptions](#AttrsOptions) +- [Gen](#Gen) + - [alias_type_decl](#alias_type_decl) + - [anon_fn](#anon_fn) + - [array_decompose](#array_decompose) + - [array_init](#array_init) + - [as_cast](#as_cast) + - [assert_stmt](#assert_stmt) + - [assign_stmt](#assign_stmt) + - [assoc](#assoc) + - [at_expr](#at_expr) + - [attrs](#attrs) + - [block](#block) + - [branch_stmt](#branch_stmt) + - [call_args](#call_args) + - [call_expr](#call_expr) + - [cast_expr](#cast_expr) + - [chan_init](#chan_init) + - [char_literal](#char_literal) + - [comptime_call](#comptime_call) + - [comptime_for](#comptime_for) + - [comptime_selector](#comptime_selector) + - [concat_expr](#concat_expr) + - [const_decl](#const_decl) + - [defer_stmt](#defer_stmt) + - [dump_expr](#dump_expr) + - [enum_decl](#enum_decl) + - [enum_val](#enum_val) + - [error](#error) + - [expr](#expr) + - [expr_stmt](#expr_stmt) + - [fn_decl](#fn_decl) + - [fn_type_decl](#fn_type_decl) + - [for_c_stmt](#for_c_stmt) + - [for_in_stmt](#for_in_stmt) + - [for_stmt](#for_stmt) + - [global_decl](#global_decl) + - [go_expr](#go_expr) + - [goto_label](#goto_label) + - [goto_stmt](#goto_stmt) + - [hash_stmt](#hash_stmt) + - [ident](#ident) + - [if_expr](#if_expr) + - [if_guard_expr](#if_guard_expr) + - [imp_stmt_str](#imp_stmt_str) + - [imports](#imports) + - [index_expr](#index_expr) + - [infix_expr](#infix_expr) + - [interface_decl](#interface_decl) + - [interface_field](#interface_field) + - [interface_method](#interface_method) + - [is_ref_type](#is_ref_type) + - [likely](#likely) + - [lock_expr](#lock_expr) + - [map_init](#map_init) + - [mark_import_as_used](#mark_import_as_used) + - [mark_types_import_as_used](#mark_types_import_as_used) + - [match_expr](#match_expr) + - [module_stmt](#module_stmt) + - [no_cur_mod](#no_cur_mod) + - [node_str](#node_str) + - [offset_of](#offset_of) + - [or_expr](#or_expr) + - [par_expr](#par_expr) + - [postfix_expr](#postfix_expr) + - [prefix_expr](#prefix_expr) + - [process_file_imports](#process_file_imports) + - [range_expr](#range_expr) + - [remove_new_line](#remove_new_line) + - [return_stmt](#return_stmt) + - [select_expr](#select_expr) + - [selector_expr](#selector_expr) + - [set_current_module_name](#set_current_module_name) + - [short_module](#short_module) + - [single_line_attrs](#single_line_attrs) + - [size_of](#size_of) + - [spawn_expr](#spawn_expr) + - [sql_expr](#sql_expr) + - [sql_stmt](#sql_stmt) + - [sql_stmt_line](#sql_stmt_line) + - [stmt](#stmt) + - [stmts](#stmts) + - [string_inter_literal](#string_inter_literal) + - [string_literal](#string_literal) + - [struct_decl](#struct_decl) + - [struct_init](#struct_init) + - [sum_type_decl](#sum_type_decl) + - [type_decl](#type_decl) + - [type_expr](#type_expr) + - [type_of](#type_of) + - [unsafe_expr](#unsafe_expr) + - [wrap_infix](#wrap_infix) + - [wrap_long_line](#wrap_long_line) + - [write](#write) + - [writeln](#writeln) +- [RemoveNewLineConfig](#RemoveNewLineConfig) + +## gen +[[Return to contents]](#Contents) + +## AttrsOptions +[[Return to contents]](#Contents) + +## Gen +[[Return to contents]](#Contents) + +## alias_type_decl +[[Return to contents]](#Contents) + +## anon_fn +[[Return to contents]](#Contents) + +## array_decompose +[[Return to contents]](#Contents) + +## array_init +[[Return to contents]](#Contents) + +## as_cast +[[Return to contents]](#Contents) + +## assert_stmt +[[Return to contents]](#Contents) + +## assign_stmt +[[Return to contents]](#Contents) + +## assoc +[[Return to contents]](#Contents) + +## at_expr +[[Return to contents]](#Contents) + +## attrs +[[Return to contents]](#Contents) + +## block +[[Return to contents]](#Contents) + +## branch_stmt +[[Return to contents]](#Contents) + +## call_args +[[Return to contents]](#Contents) + +## call_expr +[[Return to contents]](#Contents) + +## cast_expr +[[Return to contents]](#Contents) + +## chan_init +[[Return to contents]](#Contents) + +## char_literal +[[Return to contents]](#Contents) + +## comptime_call +[[Return to contents]](#Contents) + +## comptime_for +[[Return to contents]](#Contents) + +## comptime_selector +[[Return to contents]](#Contents) + +## concat_expr +[[Return to contents]](#Contents) + +## const_decl +[[Return to contents]](#Contents) + +## defer_stmt +[[Return to contents]](#Contents) + +## dump_expr +[[Return to contents]](#Contents) + +## enum_decl +[[Return to contents]](#Contents) + +## enum_val +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## expr +[[Return to contents]](#Contents) + +## expr_stmt +[[Return to contents]](#Contents) + +## fn_decl +[[Return to contents]](#Contents) + +## fn_type_decl +[[Return to contents]](#Contents) + +## for_c_stmt +[[Return to contents]](#Contents) + +## for_in_stmt +[[Return to contents]](#Contents) + +## for_stmt +[[Return to contents]](#Contents) + +## global_decl +[[Return to contents]](#Contents) + +## go_expr +[[Return to contents]](#Contents) + +## goto_label +[[Return to contents]](#Contents) + +## goto_stmt +[[Return to contents]](#Contents) + +## hash_stmt +[[Return to contents]](#Contents) + +## ident +[[Return to contents]](#Contents) + +## if_expr +[[Return to contents]](#Contents) + +## if_guard_expr +[[Return to contents]](#Contents) + +## imp_stmt_str +[[Return to contents]](#Contents) + +## imports +[[Return to contents]](#Contents) + +## index_expr +[[Return to contents]](#Contents) + +## infix_expr +[[Return to contents]](#Contents) + +## interface_decl +[[Return to contents]](#Contents) + +## interface_field +[[Return to contents]](#Contents) + +## interface_method +[[Return to contents]](#Contents) + +## is_ref_type +[[Return to contents]](#Contents) + +## likely +[[Return to contents]](#Contents) + +## lock_expr +[[Return to contents]](#Contents) + +## map_init +[[Return to contents]](#Contents) + +## mark_import_as_used +[[Return to contents]](#Contents) + +## mark_types_import_as_used +[[Return to contents]](#Contents) + +## match_expr +[[Return to contents]](#Contents) + +## module_stmt +[[Return to contents]](#Contents) + +## no_cur_mod +[[Return to contents]](#Contents) + +## node_str +[[Return to contents]](#Contents) + +## offset_of +[[Return to contents]](#Contents) + +## or_expr +[[Return to contents]](#Contents) + +## par_expr +[[Return to contents]](#Contents) + +## postfix_expr +[[Return to contents]](#Contents) + +## prefix_expr +[[Return to contents]](#Contents) + +## process_file_imports +[[Return to contents]](#Contents) + +## range_expr +[[Return to contents]](#Contents) + +## remove_new_line +[[Return to contents]](#Contents) + +## return_stmt +[[Return to contents]](#Contents) + +## select_expr +[[Return to contents]](#Contents) + +## selector_expr +[[Return to contents]](#Contents) + +## set_current_module_name +[[Return to contents]](#Contents) + +## short_module +[[Return to contents]](#Contents) + +## single_line_attrs +[[Return to contents]](#Contents) + +## size_of +[[Return to contents]](#Contents) + +## spawn_expr +[[Return to contents]](#Contents) + +## sql_expr +[[Return to contents]](#Contents) + +## sql_stmt +[[Return to contents]](#Contents) + +## sql_stmt_line +[[Return to contents]](#Contents) + +## stmt +[[Return to contents]](#Contents) + +## stmts +[[Return to contents]](#Contents) + +## string_inter_literal +[[Return to contents]](#Contents) + +## string_literal +[[Return to contents]](#Contents) + +## struct_decl +[[Return to contents]](#Contents) + +## struct_init +[[Return to contents]](#Contents) + +## sum_type_decl +[[Return to contents]](#Contents) + +## type_decl +[[Return to contents]](#Contents) + +## type_expr +[[Return to contents]](#Contents) + +## type_of +[[Return to contents]](#Contents) + +## unsafe_expr +[[Return to contents]](#Contents) + +## wrap_infix +[[Return to contents]](#Contents) + +## wrap_long_line +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## writeln +[[Return to contents]](#Contents) + +## RemoveNewLineConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.js.md b/vdocs/v.gen.js.md new file mode 100644 index 00000000..c3b3e5e2 --- /dev/null +++ b/vdocs/v.gen.js.md @@ -0,0 +1,84 @@ +# module v.gen.js + + +## Contents +- [Constants](#Constants) +- [data_str](#data_str) +- [gen](#gen) +- [type_to_str](#type_to_str) +- [JsGen](#JsGen) + - [dec_indent](#dec_indent) + - [doc_typ](#doc_typ) + - [enter_namespace](#enter_namespace) + - [escape_namespace](#escape_namespace) + - [find_class_methods](#find_class_methods) + - [gen_indent](#gen_indent) + - [gen_js_main_for_tests](#gen_js_main_for_tests) + - [inc_indent](#inc_indent) + - [init](#init) + - [new_tmp_var](#new_tmp_var) + - [push_pub_var](#push_pub_var) + - [styp](#styp) + - [write](#write) + - [writeln](#writeln) +- [StrIntpType](#StrIntpType) + +## Constants +[[Return to contents]](#Contents) + +## data_str +[[Return to contents]](#Contents) + +## gen +[[Return to contents]](#Contents) + +## type_to_str +[[Return to contents]](#Contents) + +## JsGen +## dec_indent +[[Return to contents]](#Contents) + +## doc_typ +[[Return to contents]](#Contents) + +## enter_namespace +[[Return to contents]](#Contents) + +## escape_namespace +[[Return to contents]](#Contents) + +## find_class_methods +[[Return to contents]](#Contents) + +## gen_indent +[[Return to contents]](#Contents) + +## gen_js_main_for_tests +[[Return to contents]](#Contents) + +## inc_indent +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## new_tmp_var +[[Return to contents]](#Contents) + +## push_pub_var +[[Return to contents]](#Contents) + +## styp +[[Return to contents]](#Contents) + +## write +[[Return to contents]](#Contents) + +## writeln +[[Return to contents]](#Contents) + +## StrIntpType +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.js.sourcemap.md b/vdocs/v.gen.js.sourcemap.md new file mode 100644 index 00000000..23fb4f9a --- /dev/null +++ b/vdocs/v.gen.js.sourcemap.md @@ -0,0 +1,44 @@ +# module v.gen.js.sourcemap + + +## Contents +- [generate_empty_map](#generate_empty_map) +- [new_sourcemap](#new_sourcemap) +- [Generator](#Generator) + - [add_map](#add_map) +- [SourceMap](#SourceMap) + - [add_mapping](#add_mapping) + - [add_mapping_list](#add_mapping_list) + - [set_source_content](#set_source_content) + - [to_json](#to_json) +- [SourcePosition](#SourcePosition) + +## generate_empty_map +[[Return to contents]](#Contents) + +## new_sourcemap +[[Return to contents]](#Contents) + +## Generator +## add_map +[[Return to contents]](#Contents) + +## SourceMap +[[Return to contents]](#Contents) + +## add_mapping +[[Return to contents]](#Contents) + +## add_mapping_list +[[Return to contents]](#Contents) + +## set_source_content +[[Return to contents]](#Contents) + +## to_json +[[Return to contents]](#Contents) + +## SourcePosition +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.js.sourcemap.vlq.md b/vdocs/v.gen.js.sourcemap.vlq.md new file mode 100644 index 00000000..20e50b26 --- /dev/null +++ b/vdocs/v.gen.js.sourcemap.vlq.md @@ -0,0 +1,14 @@ +# module v.gen.js.sourcemap.vlq + + +## Contents +- [decode](#decode) +- [encode](#encode) + +## decode +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.native.md b/vdocs/v.gen.native.md new file mode 100644 index 00000000..afcadf88 --- /dev/null +++ b/vdocs/v.gen.native.md @@ -0,0 +1,290 @@ +# module v.gen.native + + +## Contents +- [Constants](#Constants) +- [escape_string](#escape_string) +- [gen](#gen) +- [macho_test_new_gen](#macho_test_new_gen) +- [Amd64](#Amd64) + - [pop](#pop) + - [sub8](#sub8) + - [sub](#sub) + - [add](#add) + - [add8](#add8) + - [var_zero](#var_zero) + - [rep_stosb](#rep_stosb) + - [std](#std) + - [cld](#cld) + - [cld_repne_scasb](#cld_repne_scasb) + - [xor](#xor) + - [test_reg](#test_reg) + - [inline_strlen](#inline_strlen) + - [get_dllcall_addr](#get_dllcall_addr) + - [dllcall](#dllcall) + - [gen_print_reg](#gen_print_reg) + - [gen_exit](#gen_exit) + - [call_fn](#call_fn) + - [builtin_decl](#builtin_decl) + - [allocate_var_two_step](#allocate_var_two_step) + - [allocate_var](#allocate_var) +- [Arm64](#Arm64) + - [fn_decl](#fn_decl) + - [call_fn](#call_fn) + - [gen_exit](#gen_exit) + - [gen_arm64_exit](#gen_arm64_exit) + - [add](#add) +- [Gen](#Gen) + - [ast_fetch_external_deps](#ast_fetch_external_deps) + - [calculate_all_size_align](#calculate_all_size_align) + - [calculate_enum_fields](#calculate_enum_fields) + - [call_builtin](#call_builtin) + - [create_executable](#create_executable) + - [elf_string_table](#elf_string_table) + - [find_o_path](#find_o_path) + - [gen_dos_header](#gen_dos_header) + - [gen_dos_stub](#gen_dos_stub) + - [gen_pe_header](#gen_pe_header) + - [gen_rela_section](#gen_rela_section) + - [generate_builtins](#generate_builtins) + - [generate_elf_footer](#generate_elf_footer) + - [generate_footer](#generate_footer) + - [generate_header](#generate_header) + - [generate_linkable_elf_header](#generate_linkable_elf_header) + - [generate_macho_footer](#generate_macho_footer) + - [generate_macho_header](#generate_macho_header) + - [generate_macho_object_header](#generate_macho_object_header) + - [generate_pe_footer](#generate_pe_footer) + - [generate_pe_header](#generate_pe_header) + - [generate_simple_elf_header](#generate_simple_elf_header) + - [get_builtin_arg_reg](#get_builtin_arg_reg) + - [get_lpaths](#get_lpaths) + - [has_external_deps](#has_external_deps) + - [init_builtins](#init_builtins) + - [link](#link) + - [link_elf_file](#link_elf_file) + - [n_error](#n_error) + - [pos](#pos) + - [prepend_vobjpath](#prepend_vobjpath) + - [register_function_address](#register_function_address) + - [stmts](#stmts) + - [styp](#styp) + - [symtab_get_index](#symtab_get_index) + - [v_error](#v_error) + - [warning](#warning) + - [zeroes](#zeroes) + +## Constants +[[Return to contents]](#Contents) + +## escape_string +[[Return to contents]](#Contents) + +## gen +[[Return to contents]](#Contents) + +## macho_test_new_gen +[[Return to contents]](#Contents) + +## Amd64 +[[Return to contents]](#Contents) + +## pop +[[Return to contents]](#Contents) + +## sub8 +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## add8 +[[Return to contents]](#Contents) + +## var_zero +[[Return to contents]](#Contents) + +## rep_stosb +[[Return to contents]](#Contents) + +## std +[[Return to contents]](#Contents) + +## cld +[[Return to contents]](#Contents) + +## cld_repne_scasb +[[Return to contents]](#Contents) + +## xor +[[Return to contents]](#Contents) + +## test_reg +[[Return to contents]](#Contents) + +## inline_strlen +[[Return to contents]](#Contents) + +## get_dllcall_addr +[[Return to contents]](#Contents) + +## dllcall +[[Return to contents]](#Contents) + +## gen_print_reg +[[Return to contents]](#Contents) + +## gen_exit +[[Return to contents]](#Contents) + +## call_fn +[[Return to contents]](#Contents) + +## builtin_decl +[[Return to contents]](#Contents) + +## allocate_var_two_step +[[Return to contents]](#Contents) + +## allocate_var +[[Return to contents]](#Contents) + +## Arm64 +[[Return to contents]](#Contents) + +## fn_decl +[[Return to contents]](#Contents) + +## call_fn +[[Return to contents]](#Contents) + +## gen_exit +[[Return to contents]](#Contents) + +## gen_arm64_exit +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## Gen +[[Return to contents]](#Contents) + +## ast_fetch_external_deps +[[Return to contents]](#Contents) + +## calculate_all_size_align +[[Return to contents]](#Contents) + +## calculate_enum_fields +[[Return to contents]](#Contents) + +## call_builtin +[[Return to contents]](#Contents) + +## create_executable +[[Return to contents]](#Contents) + +## elf_string_table +[[Return to contents]](#Contents) + +## find_o_path +[[Return to contents]](#Contents) + +## gen_dos_header +[[Return to contents]](#Contents) + +## gen_dos_stub +[[Return to contents]](#Contents) + +## gen_pe_header +[[Return to contents]](#Contents) + +## gen_rela_section +[[Return to contents]](#Contents) + +## generate_builtins +[[Return to contents]](#Contents) + +## generate_elf_footer +[[Return to contents]](#Contents) + +## generate_footer +[[Return to contents]](#Contents) + +## generate_header +[[Return to contents]](#Contents) + +## generate_linkable_elf_header +[[Return to contents]](#Contents) + +## generate_macho_footer +[[Return to contents]](#Contents) + +## generate_macho_header +[[Return to contents]](#Contents) + +## generate_macho_object_header +[[Return to contents]](#Contents) + +## generate_pe_footer +[[Return to contents]](#Contents) + +## generate_pe_header +[[Return to contents]](#Contents) + +## generate_simple_elf_header +[[Return to contents]](#Contents) + +## get_builtin_arg_reg +[[Return to contents]](#Contents) + +## get_lpaths +[[Return to contents]](#Contents) + +## has_external_deps +[[Return to contents]](#Contents) + +## init_builtins +[[Return to contents]](#Contents) + +## link +[[Return to contents]](#Contents) + +## link_elf_file +[[Return to contents]](#Contents) + +## n_error +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +## prepend_vobjpath +[[Return to contents]](#Contents) + +## register_function_address +[[Return to contents]](#Contents) + +## stmts +[[Return to contents]](#Contents) + +## styp +[[Return to contents]](#Contents) + +## symtab_get_index +[[Return to contents]](#Contents) + +## v_error +[[Return to contents]](#Contents) + +## warning +[[Return to contents]](#Contents) + +## zeroes +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.wasm.md b/vdocs/v.gen.wasm.md new file mode 100644 index 00000000..4de4eefc --- /dev/null +++ b/vdocs/v.gen.wasm.md @@ -0,0 +1,338 @@ +# module v.gen.wasm + + +## Contents +- [calc_align](#calc_align) +- [calc_padding](#calc_padding) +- [gen](#gen) +- [log2](#log2) +- [unpack_literal_int](#unpack_literal_int) +- [Gen](#Gen) + - [as_numtype](#as_numtype) + - [asm_call](#asm_call) + - [asm_global_get_or_set](#asm_global_get_or_set) + - [asm_literal_arg](#asm_literal_arg) + - [asm_load_or_store](#asm_load_or_store) + - [asm_local_get_set_or_tee](#asm_local_get_set_or_tee) + - [asm_parse_align_offset](#asm_parse_align_offset) + - [asm_stmt](#asm_stmt) + - [asm_template](#asm_template) + - [bare_function_end](#bare_function_end) + - [bare_function_frame](#bare_function_frame) + - [bp](#bp) + - [calculate_enum_fields](#calculate_enum_fields) + - [call_expr](#call_expr) + - [cast](#cast) + - [comptime_cond](#comptime_cond) + - [comptime_if_expr](#comptime_if_expr) + - [comptime_if_to_ifdef](#comptime_if_to_ifdef) + - [dbg_type_name](#dbg_type_name) + - [expr](#expr) + - [expr_stmt](#expr_stmt) + - [expr_stmts](#expr_stmts) + - [expr_with_cast](#expr_with_cast) + - [field_offset](#field_offset) + - [file_pos](#file_pos) + - [fn_decl](#fn_decl) + - [fn_external_import](#fn_external_import) + - [get](#get) + - [get_field_offset](#get_field_offset) + - [get_ns_plus_name](#get_ns_plus_name) + - [get_var_from_expr](#get_var_from_expr) + - [get_var_from_ident](#get_var_from_ident) + - [get_var_or_make_from_expr](#get_var_or_make_from_expr) + - [get_wasm_type](#get_wasm_type) + - [get_wasm_type_int_literal](#get_wasm_type_int_literal) + - [handle_ptr_arithmetic](#handle_ptr_arithmetic) + - [housekeeping](#housekeeping) + - [hp](#hp) + - [if_branch](#if_branch) + - [if_expr](#if_expr) + - [infix_expr](#infix_expr) + - [infix_from_typ](#infix_from_typ) + - [is_param](#is_param) + - [is_param_type](#is_param_type) + - [is_pure_type](#is_pure_type) + - [literal](#literal) + - [literal_to_constant_expression](#literal_to_constant_expression) + - [literalint](#literalint) + - [load](#load) + - [load_field](#load_field) + - [make_vinit](#make_vinit) + - [mov](#mov) + - [new_global](#new_global) + - [new_local](#new_local) + - [offset](#offset) + - [prefix_expr](#prefix_expr) + - [ref](#ref) + - [ref_ignore_offset](#ref_ignore_offset) + - [rvar_expr_stmts](#rvar_expr_stmts) + - [set](#set) + - [set_prepare](#set_prepare) + - [set_set](#set_set) + - [set_with_expr](#set_with_expr) + - [set_with_multi_expr](#set_with_multi_expr) + - [sp](#sp) + - [store](#store) + - [store_field](#store_field) + - [tee](#tee) + - [toplevel_stmt](#toplevel_stmt) + - [toplevel_stmts](#toplevel_stmts) + - [unpack_type](#unpack_type) + - [v_error](#v_error) + - [w_error](#w_error) + - [warning](#warning) + - [zero_fill](#zero_fill) +- [LoopBreakpoint](#LoopBreakpoint) +- [Var](#Var) + +## calc_align +[[Return to contents]](#Contents) + +## calc_padding +[[Return to contents]](#Contents) + +## gen +[[Return to contents]](#Contents) + +## log2 +[[Return to contents]](#Contents) + +## unpack_literal_int +[[Return to contents]](#Contents) + +## Gen +[[Return to contents]](#Contents) + +## as_numtype +[[Return to contents]](#Contents) + +## asm_call +[[Return to contents]](#Contents) + +## asm_global_get_or_set +[[Return to contents]](#Contents) + +## asm_literal_arg +[[Return to contents]](#Contents) + +## asm_load_or_store +[[Return to contents]](#Contents) + +## asm_local_get_set_or_tee +[[Return to contents]](#Contents) + +## asm_parse_align_offset +[[Return to contents]](#Contents) + +## asm_stmt +[[Return to contents]](#Contents) + +## asm_template +[[Return to contents]](#Contents) + +## bare_function_end +[[Return to contents]](#Contents) + +## bare_function_frame +[[Return to contents]](#Contents) + +## bp +[[Return to contents]](#Contents) + +## calculate_enum_fields +[[Return to contents]](#Contents) + +## call_expr +[[Return to contents]](#Contents) + +## cast +[[Return to contents]](#Contents) + +## comptime_cond +[[Return to contents]](#Contents) + +## comptime_if_expr +[[Return to contents]](#Contents) + +## comptime_if_to_ifdef +[[Return to contents]](#Contents) + +## dbg_type_name +[[Return to contents]](#Contents) + +## expr +[[Return to contents]](#Contents) + +## expr_stmt +[[Return to contents]](#Contents) + +## expr_stmts +[[Return to contents]](#Contents) + +## expr_with_cast +[[Return to contents]](#Contents) + +## field_offset +[[Return to contents]](#Contents) + +## file_pos +[[Return to contents]](#Contents) + +## fn_decl +[[Return to contents]](#Contents) + +## fn_external_import +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## get_field_offset +[[Return to contents]](#Contents) + +## get_ns_plus_name +[[Return to contents]](#Contents) + +## get_var_from_expr +[[Return to contents]](#Contents) + +## get_var_from_ident +[[Return to contents]](#Contents) + +## get_var_or_make_from_expr +[[Return to contents]](#Contents) + +## get_wasm_type +[[Return to contents]](#Contents) + +## get_wasm_type_int_literal +[[Return to contents]](#Contents) + +## handle_ptr_arithmetic +[[Return to contents]](#Contents) + +## housekeeping +[[Return to contents]](#Contents) + +## hp +[[Return to contents]](#Contents) + +## if_branch +[[Return to contents]](#Contents) + +## if_expr +[[Return to contents]](#Contents) + +## infix_expr +[[Return to contents]](#Contents) + +## infix_from_typ +[[Return to contents]](#Contents) + +## is_param +[[Return to contents]](#Contents) + +## is_param_type +[[Return to contents]](#Contents) + +## is_pure_type +[[Return to contents]](#Contents) + +## literal +[[Return to contents]](#Contents) + +## literal_to_constant_expression +[[Return to contents]](#Contents) + +## literalint +[[Return to contents]](#Contents) + +## load +[[Return to contents]](#Contents) + +## load_field +[[Return to contents]](#Contents) + +## make_vinit +[[Return to contents]](#Contents) + +## mov +[[Return to contents]](#Contents) + +## new_global +[[Return to contents]](#Contents) + +## new_local +[[Return to contents]](#Contents) + +## offset +[[Return to contents]](#Contents) + +## prefix_expr +[[Return to contents]](#Contents) + +## ref +[[Return to contents]](#Contents) + +## ref_ignore_offset +[[Return to contents]](#Contents) + +## rvar_expr_stmts +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## set_prepare +[[Return to contents]](#Contents) + +## set_set +[[Return to contents]](#Contents) + +## set_with_expr +[[Return to contents]](#Contents) + +## set_with_multi_expr +[[Return to contents]](#Contents) + +## sp +[[Return to contents]](#Contents) + +## store +[[Return to contents]](#Contents) + +## store_field +[[Return to contents]](#Contents) + +## tee +[[Return to contents]](#Contents) + +## toplevel_stmt +[[Return to contents]](#Contents) + +## toplevel_stmts +[[Return to contents]](#Contents) + +## unpack_type +[[Return to contents]](#Contents) + +## v_error +[[Return to contents]](#Contents) + +## w_error +[[Return to contents]](#Contents) + +## warning +[[Return to contents]](#Contents) + +## zero_fill +[[Return to contents]](#Contents) + +## LoopBreakpoint +[[Return to contents]](#Contents) + +## Var +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.gen.wasm.serialise.md b/vdocs/v.gen.wasm.serialise.md new file mode 100644 index 00000000..49c35900 --- /dev/null +++ b/vdocs/v.gen.wasm.serialise.md @@ -0,0 +1,50 @@ +# module v.gen.wasm.serialise + + +## Contents +- [eval_escape_codes](#eval_escape_codes) +- [eval_escape_codes_raw](#eval_escape_codes_raw) +- [new_pool](#new_pool) +- [Pool](#Pool) + - [type_struct_info](#type_struct_info) + - [type_size](#type_size) + - [append_string](#append_string) + - [append](#append) +- [PoolOpts](#PoolOpts) +- [Reloc](#Reloc) +- [StructInfo](#StructInfo) + +## eval_escape_codes +[[Return to contents]](#Contents) + +## eval_escape_codes_raw +[[Return to contents]](#Contents) + +## new_pool +[[Return to contents]](#Contents) + +## Pool +[[Return to contents]](#Contents) + +## type_struct_info +[[Return to contents]](#Contents) + +## type_size +[[Return to contents]](#Contents) + +## append_string +[[Return to contents]](#Contents) + +## append +[[Return to contents]](#Contents) + +## PoolOpts +[[Return to contents]](#Contents) + +## Reloc +[[Return to contents]](#Contents) + +## StructInfo +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.help.md b/vdocs/v.help.md new file mode 100644 index 00000000..c658ff17 --- /dev/null +++ b/vdocs/v.help.md @@ -0,0 +1,14 @@ +# module v.help + + +## Contents +- [print_and_exit](#print_and_exit) +- [ExitOptions](#ExitOptions) + +## print_and_exit +[[Return to contents]](#Contents) + +## ExitOptions +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.live.executable.md b/vdocs/v.live.executable.md new file mode 100644 index 00000000..99d0fb68 --- /dev/null +++ b/vdocs/v.live.executable.md @@ -0,0 +1,18 @@ +# module v.live.executable + + +## Contents +- [add_live_monitored_file](#add_live_monitored_file) +- [new_live_reload_info](#new_live_reload_info) +- [start_reloader](#start_reloader) + +## add_live_monitored_file +[[Return to contents]](#Contents) + +## new_live_reload_info +[[Return to contents]](#Contents) + +## start_reloader +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.live.md b/vdocs/v.live.md new file mode 100644 index 00000000..af23fba3 --- /dev/null +++ b/vdocs/v.live.md @@ -0,0 +1,22 @@ +# module v.live + + +## Contents +- [info](#info) +- [FNLinkLiveSymbols](#FNLinkLiveSymbols) +- [FNLiveReloadCB](#FNLiveReloadCB) +- [LiveReloadInfo](#LiveReloadInfo) + +## info +[[Return to contents]](#Contents) + +## FNLinkLiveSymbols +[[Return to contents]](#Contents) + +## FNLiveReloadCB +[[Return to contents]](#Contents) + +## LiveReloadInfo +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.live.sharedlib.md b/vdocs/v.live.sharedlib.md new file mode 100644 index 00000000..8900f0cf --- /dev/null +++ b/vdocs/v.live.sharedlib.md @@ -0,0 +1,10 @@ +# module v.live.sharedlib + + +## Contents +- [set_live_reload_pointer](#set_live_reload_pointer) + +## set_live_reload_pointer +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.markused.md b/vdocs/v.markused.md new file mode 100644 index 00000000..2497d622 --- /dev/null +++ b/vdocs/v.markused.md @@ -0,0 +1,90 @@ +# module v.markused + + +## Contents +- [mark_used](#mark_used) +- [Walker.new](#Walker.new) +- [Walker](#Walker) + - [mark_fn_as_used](#mark_fn_as_used) + - [mark_builtin_array_method_as_used](#mark_builtin_array_method_as_used) + - [mark_builtin_map_method_as_used](#mark_builtin_map_method_as_used) + - [mark_builtin_type_method_as_used](#mark_builtin_type_method_as_used) + - [mark_const_as_used](#mark_const_as_used) + - [mark_global_as_used](#mark_global_as_used) + - [mark_markused_fns](#mark_markused_fns) + - [mark_root_fns](#mark_root_fns) + - [mark_markused_consts](#mark_markused_consts) + - [mark_markused_globals](#mark_markused_globals) + - [stmt](#stmt) + - [a_struct_info](#a_struct_info) + - [fn_decl](#fn_decl) + - [call_expr](#call_expr) + - [fn_by_name](#fn_by_name) + - [struct_fields](#struct_fields) + - [const_fields](#const_fields) + - [or_block](#or_block) + +## mark_used +[[Return to contents]](#Contents) + +## Walker.new +[[Return to contents]](#Contents) + +## Walker +[[Return to contents]](#Contents) + +## mark_fn_as_used +[[Return to contents]](#Contents) + +## mark_builtin_array_method_as_used +[[Return to contents]](#Contents) + +## mark_builtin_map_method_as_used +[[Return to contents]](#Contents) + +## mark_builtin_type_method_as_used +[[Return to contents]](#Contents) + +## mark_const_as_used +[[Return to contents]](#Contents) + +## mark_global_as_used +[[Return to contents]](#Contents) + +## mark_markused_fns +[[Return to contents]](#Contents) + +## mark_root_fns +[[Return to contents]](#Contents) + +## mark_markused_consts +[[Return to contents]](#Contents) + +## mark_markused_globals +[[Return to contents]](#Contents) + +## stmt +[[Return to contents]](#Contents) + +## a_struct_info +[[Return to contents]](#Contents) + +## fn_decl +[[Return to contents]](#Contents) + +## call_expr +[[Return to contents]](#Contents) + +## fn_by_name +[[Return to contents]](#Contents) + +## struct_fields +[[Return to contents]](#Contents) + +## const_fields +[[Return to contents]](#Contents) + +## or_block +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.mathutil.md b/vdocs/v.mathutil.md new file mode 100644 index 00000000..46479cb4 --- /dev/null +++ b/vdocs/v.mathutil.md @@ -0,0 +1,18 @@ +# module v.mathutil + + +## Contents +- [abs](#abs) +- [max](#max) +- [min](#min) + +## abs +[[Return to contents]](#Contents) + +## max +[[Return to contents]](#Contents) + +## min +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.parser.md b/vdocs/v.parser.md new file mode 100644 index 00000000..b6d33794 --- /dev/null +++ b/vdocs/v.parser.md @@ -0,0 +1,50 @@ +# module v.parser + + +## Contents +- [parse_comptime](#parse_comptime) +- [parse_file](#parse_file) +- [parse_files](#parse_files) +- [parse_stmt](#parse_stmt) +- [parse_text](#parse_text) +- [Parser](#Parser) + - [codegen](#codegen) + - [compile_template_file](#compile_template_file) + - [free](#free) + - [parse](#parse) + - [set_path](#set_path) + +## parse_comptime +[[Return to contents]](#Contents) + +## parse_file +[[Return to contents]](#Contents) + +## parse_files +[[Return to contents]](#Contents) + +## parse_stmt +[[Return to contents]](#Contents) + +## parse_text +[[Return to contents]](#Contents) + +## Parser +[[Return to contents]](#Contents) + +## codegen +[[Return to contents]](#Contents) + +## compile_template_file +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## parse +[[Return to contents]](#Contents) + +## set_path +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.pkgconfig.md b/vdocs/v.pkgconfig.md new file mode 100644 index 00000000..d05d2424 --- /dev/null +++ b/vdocs/v.pkgconfig.md @@ -0,0 +1,46 @@ +# module v.pkgconfig + + +## Contents +- [atleast](#atleast) +- [list](#list) +- [load](#load) +- [main](#main) +- [Main](#Main) + - [run](#run) +- [Options](#Options) +- [PkgConfig](#PkgConfig) + - [atleast](#atleast) + - [extend](#extend) + +## atleast +[[Return to contents]](#Contents) + +## list +[[Return to contents]](#Contents) + +## load +[[Return to contents]](#Contents) + +## main +[[Return to contents]](#Contents) + +## Main +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## Options +[[Return to contents]](#Contents) + +## PkgConfig +[[Return to contents]](#Contents) + +## atleast +[[Return to contents]](#Contents) + +## extend +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.pref.md b/vdocs/v.pref.md new file mode 100644 index 00000000..b24c34a7 --- /dev/null +++ b/vdocs/v.pref.md @@ -0,0 +1,184 @@ +# module v.pref + + +## Contents +- [Constants](#Constants) +- [add_line_info_expr_to_program_text](#add_line_info_expr_to_program_text) +- [arch_from_string](#arch_from_string) +- [backend_from_string](#backend_from_string) +- [cc_from_string](#cc_from_string) +- [default_tcc_compiler](#default_tcc_compiler) +- [eprintln_cond](#eprintln_cond) +- [eprintln_exit](#eprintln_exit) +- [get_host_arch](#get_host_arch) +- [get_host_os](#get_host_os) +- [new_preferences](#new_preferences) +- [os_from_string](#os_from_string) +- [parse_args](#parse_args) +- [parse_args_and_show_errors](#parse_args_and_show_errors) +- [supported_test_runners_list](#supported_test_runners_list) +- [vexe_path](#vexe_path) +- [Arch](#Arch) +- [AssertFailureMode](#AssertFailureMode) +- [Backend](#Backend) + - [is_js](#is_js) +- [BuildMode](#BuildMode) +- [ColorOutput](#ColorOutput) +- [CompilerType](#CompilerType) +- [GarbageCollectionMode](#GarbageCollectionMode) +- [OS](#OS) + - [is_target_of](#is_target_of) + - [str](#str) +- [OutputMode](#OutputMode) +- [Subsystem](#Subsystem) +- [LineInfo](#LineInfo) +- [Preferences](#Preferences) + - [default_c_compiler](#default_c_compiler) + - [default_cpp_compiler](#default_cpp_compiler) + - [fill_with_defaults](#fill_with_defaults) + - [should_compile_asm](#should_compile_asm) + - [should_compile_c](#should_compile_c) + - [should_compile_filtered_files](#should_compile_filtered_files) + - [should_compile_js](#should_compile_js) + - [should_compile_native](#should_compile_native) + - [should_output_to_stdout](#should_output_to_stdout) + - [should_trace_fn_name](#should_trace_fn_name) + - [vcross_compiler_name](#vcross_compiler_name) + - [vcross_linker_name](#vcross_linker_name) + - [vrun_elog](#vrun_elog) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## add_line_info_expr_to_program_text +[[Return to contents]](#Contents) + +## arch_from_string +[[Return to contents]](#Contents) + +## backend_from_string +[[Return to contents]](#Contents) + +## cc_from_string +[[Return to contents]](#Contents) + +## default_tcc_compiler +[[Return to contents]](#Contents) + +## eprintln_cond +[[Return to contents]](#Contents) + +## eprintln_exit +[[Return to contents]](#Contents) + +## get_host_arch +[[Return to contents]](#Contents) + +## get_host_os +[[Return to contents]](#Contents) + +## new_preferences +[[Return to contents]](#Contents) + +## os_from_string +[[Return to contents]](#Contents) + +## parse_args +[[Return to contents]](#Contents) + +## parse_args_and_show_errors +[[Return to contents]](#Contents) + +## supported_test_runners_list +[[Return to contents]](#Contents) + +## vexe_path +[[Return to contents]](#Contents) + +## Arch +[[Return to contents]](#Contents) + +## AssertFailureMode +[[Return to contents]](#Contents) + +## Backend +[[Return to contents]](#Contents) + +## is_js +[[Return to contents]](#Contents) + +## BuildMode +[[Return to contents]](#Contents) + +## ColorOutput +[[Return to contents]](#Contents) + +## CompilerType +[[Return to contents]](#Contents) + +## GarbageCollectionMode +[[Return to contents]](#Contents) + +## OS +[[Return to contents]](#Contents) + +## is_target_of +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## OutputMode +[[Return to contents]](#Contents) + +## Subsystem +[[Return to contents]](#Contents) + +## LineInfo +[[Return to contents]](#Contents) + +## Preferences +[[Return to contents]](#Contents) + +## default_c_compiler +[[Return to contents]](#Contents) + +## default_cpp_compiler +[[Return to contents]](#Contents) + +## fill_with_defaults +[[Return to contents]](#Contents) + +## should_compile_asm +[[Return to contents]](#Contents) + +## should_compile_c +[[Return to contents]](#Contents) + +## should_compile_filtered_files +[[Return to contents]](#Contents) + +## should_compile_js +[[Return to contents]](#Contents) + +## should_compile_native +[[Return to contents]](#Contents) + +## should_output_to_stdout +[[Return to contents]](#Contents) + +## should_trace_fn_name +[[Return to contents]](#Contents) + +## vcross_compiler_name +[[Return to contents]](#Contents) + +## vcross_linker_name +[[Return to contents]](#Contents) + +## vrun_elog +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.profile.md b/vdocs/v.profile.md new file mode 100644 index 00000000..db51eeee --- /dev/null +++ b/vdocs/v.profile.md @@ -0,0 +1,14 @@ +# module v.profile + + +## Contents +- [on](#on) +- [state](#state) + +## on +[[Return to contents]](#Contents) + +## state +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.reflection.md b/vdocs/v.reflection.md new file mode 100644 index 00000000..67d8e547 --- /dev/null +++ b/vdocs/v.reflection.md @@ -0,0 +1,168 @@ +# module v.reflection + + +## Contents +- [get_aliases](#get_aliases) +- [get_enums](#get_enums) +- [get_funcs](#get_funcs) +- [get_interfaces](#get_interfaces) +- [get_modules](#get_modules) +- [get_string_by_idx](#get_string_by_idx) +- [get_structs](#get_structs) +- [get_sum_types](#get_sum_types) +- [get_type](#get_type) +- [get_type_symbol](#get_type_symbol) +- [get_type_symbols](#get_type_symbols) +- [get_types](#get_types) +- [type_name](#type_name) +- [type_of](#type_of) +- [type_symbol_name](#type_symbol_name) +- [TypeInfo](#TypeInfo) +- [VType](#VType) + - [has_flag](#has_flag) + - [idx](#idx) + - [str](#str) + - [is_ptr](#is_ptr) +- [VKind](#VKind) +- [VLanguage](#VLanguage) +- [VTypeFlag](#VTypeFlag) +- [Alias](#Alias) +- [Array](#Array) +- [ArrayFixed](#ArrayFixed) +- [Enum](#Enum) +- [Function](#Function) +- [FunctionArg](#FunctionArg) +- [Interface](#Interface) +- [Map](#Map) +- [Module](#Module) +- [MultiReturn](#MultiReturn) +- [None](#None) +- [Reflection](#Reflection) +- [Struct](#Struct) +- [StructField](#StructField) +- [SumType](#SumType) +- [Type](#Type) +- [TypeSymbol](#TypeSymbol) + +## get_aliases +[[Return to contents]](#Contents) + +## get_enums +[[Return to contents]](#Contents) + +## get_funcs +[[Return to contents]](#Contents) + +## get_interfaces +[[Return to contents]](#Contents) + +## get_modules +[[Return to contents]](#Contents) + +## get_string_by_idx +[[Return to contents]](#Contents) + +## get_structs +[[Return to contents]](#Contents) + +## get_sum_types +[[Return to contents]](#Contents) + +## get_type +[[Return to contents]](#Contents) + +## get_type_symbol +[[Return to contents]](#Contents) + +## get_type_symbols +[[Return to contents]](#Contents) + +## get_types +[[Return to contents]](#Contents) + +## type_name +[[Return to contents]](#Contents) + +## type_of +[[Return to contents]](#Contents) + +## type_symbol_name +[[Return to contents]](#Contents) + +## TypeInfo +[[Return to contents]](#Contents) + +## VType +## has_flag +[[Return to contents]](#Contents) + +## idx +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## is_ptr +[[Return to contents]](#Contents) + +## VKind +[[Return to contents]](#Contents) + +## VLanguage +[[Return to contents]](#Contents) + +## VTypeFlag +[[Return to contents]](#Contents) + +## Alias +[[Return to contents]](#Contents) + +## Array +[[Return to contents]](#Contents) + +## ArrayFixed +[[Return to contents]](#Contents) + +## Enum +[[Return to contents]](#Contents) + +## Function +[[Return to contents]](#Contents) + +## FunctionArg +[[Return to contents]](#Contents) + +## Interface +[[Return to contents]](#Contents) + +## Map +[[Return to contents]](#Contents) + +## Module +[[Return to contents]](#Contents) + +## MultiReturn +[[Return to contents]](#Contents) + +## None +[[Return to contents]](#Contents) + +## Reflection +[[Return to contents]](#Contents) + +## Struct +[[Return to contents]](#Contents) + +## StructField +[[Return to contents]](#Contents) + +## SumType +[[Return to contents]](#Contents) + +## Type +[[Return to contents]](#Contents) + +## TypeSymbol +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.scanner.md b/vdocs/v.scanner.md new file mode 100644 index 00000000..9b8ba76f --- /dev/null +++ b/vdocs/v.scanner.md @@ -0,0 +1,94 @@ +# module v.scanner + + +## Contents +- [new_scanner](#new_scanner) +- [new_scanner_file](#new_scanner_file) +- [new_silent_scanner](#new_silent_scanner) +- [CommentsMode](#CommentsMode) +- [Scanner](#Scanner) + - [free](#free) + - [set_is_inside_toplevel_statement](#set_is_inside_toplevel_statement) + - [set_current_tidx](#set_current_tidx) + - [scan](#scan) + - [peek_token](#peek_token) + - [text_scan](#text_scan) + - [ident_string](#ident_string) + - [ident_char](#ident_char) + - [current_pos](#current_pos) + - [note](#note) + - [add_error_detail](#add_error_detail) + - [add_error_detail_with_pos](#add_error_detail_with_pos) + - [warn](#warn) + - [warn_with_pos](#warn_with_pos) + - [error](#error) + - [error_with_pos](#error_with_pos) + - [prepare_for_new_text](#prepare_for_new_text) + +## new_scanner +[[Return to contents]](#Contents) + +## new_scanner_file +[[Return to contents]](#Contents) + +## new_silent_scanner +[[Return to contents]](#Contents) + +## CommentsMode +[[Return to contents]](#Contents) + +## Scanner +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## set_is_inside_toplevel_statement +[[Return to contents]](#Contents) + +## set_current_tidx +[[Return to contents]](#Contents) + +## scan +[[Return to contents]](#Contents) + +## peek_token +[[Return to contents]](#Contents) + +## text_scan +[[Return to contents]](#Contents) + +## ident_string +[[Return to contents]](#Contents) + +## ident_char +[[Return to contents]](#Contents) + +## current_pos +[[Return to contents]](#Contents) + +## note +[[Return to contents]](#Contents) + +## add_error_detail +[[Return to contents]](#Contents) + +## add_error_detail_with_pos +[[Return to contents]](#Contents) + +## warn +[[Return to contents]](#Contents) + +## warn_with_pos +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## error_with_pos +[[Return to contents]](#Contents) + +## prepare_for_new_text +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.token.md b/vdocs/v.token.md new file mode 100644 index 00000000..64d92c1a --- /dev/null +++ b/vdocs/v.token.md @@ -0,0 +1,186 @@ +# module v.token + + +## Contents +- [Constants](#Constants) +- [assign_op_to_infix_op](#assign_op_to_infix_op) +- [build_precedences](#build_precedences) +- [is_decl](#is_decl) +- [is_key](#is_key) +- [kind_to_string](#kind_to_string) +- [new_keywords_matcher_from_array_trie](#new_keywords_matcher_from_array_trie) +- [new_keywords_matcher_trie](#new_keywords_matcher_trie) +- [new_trie_node](#new_trie_node) +- [KeywordsMatcherTrie.new](#KeywordsMatcherTrie.new) +- [AtKind](#AtKind) +- [Kind](#Kind) + - [is_assign](#is_assign) + - [str](#str) + - [precedence](#precedence) + - [is_relational](#is_relational) + - [is_start_of_type](#is_start_of_type) + - [is_prefix](#is_prefix) + - [is_infix](#is_infix) + - [is_postfix](#is_postfix) +- [Precedence](#Precedence) +- [KeywordsMatcherTrie](#KeywordsMatcherTrie) + - [find](#find) + - [matches](#matches) + - [add_word](#add_word) +- [Pos](#Pos) + - [free](#free) + - [line_str](#line_str) + - [extend](#extend) + - [extend_with_last_line](#extend_with_last_line) + - [update_last_line](#update_last_line) +- [Token](#Token) + - [debug](#debug) + - [is_next_to](#is_next_to) + - [is_scalar](#is_scalar) + - [is_unary](#is_unary) + - [pos](#pos) + - [precedence](#precedence) + - [str](#str) +- [TrieNode](#TrieNode) + - [show](#show) + - [add_word](#add_word) + - [find](#find) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## assign_op_to_infix_op +[[Return to contents]](#Contents) + +## build_precedences +[[Return to contents]](#Contents) + +## is_decl +[[Return to contents]](#Contents) + +## is_key +[[Return to contents]](#Contents) + +## kind_to_string +[[Return to contents]](#Contents) + +## new_keywords_matcher_from_array_trie +[[Return to contents]](#Contents) + +## new_keywords_matcher_trie +[[Return to contents]](#Contents) + +## new_trie_node +[[Return to contents]](#Contents) + +## KeywordsMatcherTrie.new +[[Return to contents]](#Contents) + +## AtKind +[[Return to contents]](#Contents) + +## Kind +[[Return to contents]](#Contents) + +## is_assign +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## precedence +[[Return to contents]](#Contents) + +## is_relational +[[Return to contents]](#Contents) + +## is_start_of_type +[[Return to contents]](#Contents) + +## is_prefix +[[Return to contents]](#Contents) + +## is_infix +[[Return to contents]](#Contents) + +## is_postfix +[[Return to contents]](#Contents) + +## Precedence +[[Return to contents]](#Contents) + +## KeywordsMatcherTrie +[[Return to contents]](#Contents) + +## find +[[Return to contents]](#Contents) + +## matches +[[Return to contents]](#Contents) + +## add_word +[[Return to contents]](#Contents) + +## Pos +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## line_str +[[Return to contents]](#Contents) + +## extend +[[Return to contents]](#Contents) + +## extend_with_last_line +[[Return to contents]](#Contents) + +## update_last_line +[[Return to contents]](#Contents) + +## Token +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## is_next_to +[[Return to contents]](#Contents) + +## is_scalar +[[Return to contents]](#Contents) + +## is_unary +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +## precedence +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## TrieNode +[[Return to contents]](#Contents) + +## show +[[Return to contents]](#Contents) + +## add_word +[[Return to contents]](#Contents) + +## find +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.trace_calls.md b/vdocs/v.trace_calls.md new file mode 100644 index 00000000..9b93fb6c --- /dev/null +++ b/vdocs/v.trace_calls.md @@ -0,0 +1,18 @@ +# module v.trace_calls + + +## Contents +- [on_c_main](#on_c_main) +- [on_call](#on_call) +- [C.timespec](#C.timespec) + +## on_c_main +[[Return to contents]](#Contents) + +## on_call +[[Return to contents]](#Contents) + +## C.timespec +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.transformer.md b/vdocs/v.transformer.md new file mode 100644 index 00000000..58137c55 --- /dev/null +++ b/vdocs/v.transformer.md @@ -0,0 +1,106 @@ +# module v.transformer + + +## Contents +- [new_transformer](#new_transformer) +- [new_transformer_with_table](#new_transformer_with_table) +- [IndexState](#IndexState) +- [Transformer](#Transformer) + - [transform_files](#transform_files) + - [transform](#transform) + - [find_new_array_len](#find_new_array_len) + - [find_new_range](#find_new_range) + - [find_mut_self_assign](#find_mut_self_assign) + - [check_safe_array](#check_safe_array) + - [stmt](#stmt) + - [assert_stmt](#assert_stmt) + - [expr_stmt_if_expr](#expr_stmt_if_expr) + - [expr_stmt_match_expr](#expr_stmt_match_expr) + - [for_c_stmt](#for_c_stmt) + - [for_stmt](#for_stmt) + - [interface_decl](#interface_decl) + - [expr](#expr) + - [call_expr](#call_expr) + - [infix_expr](#infix_expr) + - [if_expr](#if_expr) + - [match_expr](#match_expr) + - [sql_expr](#sql_expr) + - [fn_decl_trace_calls](#fn_decl_trace_calls) + - [simplify_nested_interpolation_in_sb](#simplify_nested_interpolation_in_sb) + +## new_transformer +[[Return to contents]](#Contents) + +## new_transformer_with_table +[[Return to contents]](#Contents) + +## IndexState +[[Return to contents]](#Contents) + +## Transformer +[[Return to contents]](#Contents) + +## transform_files +[[Return to contents]](#Contents) + +## transform +[[Return to contents]](#Contents) + +## find_new_array_len +[[Return to contents]](#Contents) + +## find_new_range +[[Return to contents]](#Contents) + +## find_mut_self_assign +[[Return to contents]](#Contents) + +## check_safe_array +[[Return to contents]](#Contents) + +## stmt +[[Return to contents]](#Contents) + +## assert_stmt +[[Return to contents]](#Contents) + +## expr_stmt_if_expr +[[Return to contents]](#Contents) + +## expr_stmt_match_expr +[[Return to contents]](#Contents) + +## for_c_stmt +[[Return to contents]](#Contents) + +## for_stmt +[[Return to contents]](#Contents) + +## interface_decl +[[Return to contents]](#Contents) + +## expr +[[Return to contents]](#Contents) + +## call_expr +[[Return to contents]](#Contents) + +## infix_expr +[[Return to contents]](#Contents) + +## if_expr +[[Return to contents]](#Contents) + +## match_expr +[[Return to contents]](#Contents) + +## sql_expr +[[Return to contents]](#Contents) + +## fn_decl_trace_calls +[[Return to contents]](#Contents) + +## simplify_nested_interpolation_in_sb +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.type_resolver.md b/vdocs/v.type_resolver.md new file mode 100644 index 00000000..91b01fe8 --- /dev/null +++ b/vdocs/v.type_resolver.md @@ -0,0 +1,130 @@ +# module v.type_resolver + + +## Contents +- [TypeResolver.new](#TypeResolver.new) +- [IResolverType](#IResolverType) +- [DummyResolver](#DummyResolver) +- [ResolverInfo](#ResolverInfo) + - [check_comptime_is_field_selector](#check_comptime_is_field_selector) + - [check_comptime_is_field_selector_bool](#check_comptime_is_field_selector_bool) + - [get_ct_type_var](#get_ct_type_var) + - [has_comptime_expr](#has_comptime_expr) + - [is_comptime](#is_comptime) + - [is_comptime_selector_field_name](#is_comptime_selector_field_name) + - [is_comptime_selector_type](#is_comptime_selector_type) + - [is_comptime_variant_var](#is_comptime_variant_var) +- [TypeResolver](#TypeResolver) + - [get_comptime_selector_bool_field](#get_comptime_selector_bool_field) + - [get_comptime_selector_type](#get_comptime_selector_type) + - [get_comptime_selector_var_type](#get_comptime_selector_var_type) + - [get_ct_type_or_default](#get_ct_type_or_default) + - [get_generic_array_element_type](#get_generic_array_element_type) + - [get_generic_array_fixed_element_type](#get_generic_array_fixed_element_type) + - [get_type](#get_type) + - [get_type_from_comptime_var](#get_type_from_comptime_var) + - [get_type_or_default](#get_type_or_default) + - [is_comptime_type](#is_comptime_type) + - [is_generic_expr](#is_generic_expr) + - [is_generic_param_var](#is_generic_param_var) + - [promote_type](#promote_type) + - [resolve_args](#resolve_args) + - [resolve_fn_generic_args](#resolve_fn_generic_args) + - [typeof_type](#typeof_type) + - [unwrap_generic_expr](#unwrap_generic_expr) + - [update_ct_type](#update_ct_type) + +## TypeResolver.new +[[Return to contents]](#Contents) + +## IResolverType +[[Return to contents]](#Contents) + +## DummyResolver +[[Return to contents]](#Contents) + +## ResolverInfo +[[Return to contents]](#Contents) + +## check_comptime_is_field_selector +[[Return to contents]](#Contents) + +## check_comptime_is_field_selector_bool +[[Return to contents]](#Contents) + +## get_ct_type_var +[[Return to contents]](#Contents) + +## has_comptime_expr +[[Return to contents]](#Contents) + +## is_comptime +[[Return to contents]](#Contents) + +## is_comptime_selector_field_name +[[Return to contents]](#Contents) + +## is_comptime_selector_type +[[Return to contents]](#Contents) + +## is_comptime_variant_var +[[Return to contents]](#Contents) + +## TypeResolver +[[Return to contents]](#Contents) + +## get_comptime_selector_bool_field +[[Return to contents]](#Contents) + +## get_comptime_selector_type +[[Return to contents]](#Contents) + +## get_comptime_selector_var_type +[[Return to contents]](#Contents) + +## get_ct_type_or_default +[[Return to contents]](#Contents) + +## get_generic_array_element_type +[[Return to contents]](#Contents) + +## get_generic_array_fixed_element_type +[[Return to contents]](#Contents) + +## get_type +[[Return to contents]](#Contents) + +## get_type_from_comptime_var +[[Return to contents]](#Contents) + +## get_type_or_default +[[Return to contents]](#Contents) + +## is_comptime_type +[[Return to contents]](#Contents) + +## is_generic_expr +[[Return to contents]](#Contents) + +## is_generic_param_var +[[Return to contents]](#Contents) + +## promote_type +[[Return to contents]](#Contents) + +## resolve_args +[[Return to contents]](#Contents) + +## resolve_fn_generic_args +[[Return to contents]](#Contents) + +## typeof_type +[[Return to contents]](#Contents) + +## unwrap_generic_expr +[[Return to contents]](#Contents) + +## update_ct_type +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.util.diff.md b/vdocs/v.util.diff.md new file mode 100644 index 00000000..f0b44e5b --- /dev/null +++ b/vdocs/v.util.diff.md @@ -0,0 +1,42 @@ +# module v.util.diff + + +## Contents +- [available_tools](#available_tools) +- [color_compare_files](#color_compare_files) +- [color_compare_strings](#color_compare_strings) +- [compare_files](#compare_files) +- [compare_text](#compare_text) +- [find_working_diff_command](#find_working_diff_command) +- [DiffTool](#DiffTool) +- [CompareOptions](#CompareOptions) +- [CompareTextOptions](#CompareTextOptions) + +## available_tools +[[Return to contents]](#Contents) + +## color_compare_files +[[Return to contents]](#Contents) + +## color_compare_strings +[[Return to contents]](#Contents) + +## compare_files +[[Return to contents]](#Contents) + +## compare_text +[[Return to contents]](#Contents) + +## find_working_diff_command +[[Return to contents]](#Contents) + +## DiffTool +[[Return to contents]](#Contents) + +## CompareOptions +[[Return to contents]](#Contents) + +## CompareTextOptions +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.util.md b/vdocs/v.util.md new file mode 100644 index 00000000..784f295b --- /dev/null +++ b/vdocs/v.util.md @@ -0,0 +1,376 @@ +# module v.util + + +## Contents +- [Constants](#Constants) +- [args_quote_paths](#args_quote_paths) +- [bold](#bold) +- [cached_file2sourcelines](#cached_file2sourcelines) +- [cached_read_source_file](#cached_read_source_file) +- [cescaped_path](#cescaped_path) +- [check_module_is_installed](#check_module_is_installed) +- [color](#color) +- [contains_capital](#contains_capital) +- [ensure_modules_for_all_tools_are_installed](#ensure_modules_for_all_tools_are_installed) +- [find_all_v_files](#find_all_v_files) +- [formatted_error](#formatted_error) +- [free_caches](#free_caches) +- [get_build_time](#get_build_time) +- [get_timers](#get_timers) +- [get_vtmp_folder](#get_vtmp_folder) +- [good_type_name](#good_type_name) +- [highlight_suggestion](#highlight_suggestion) +- [is_escape_sequence](#is_escape_sequence) +- [is_func_char](#is_func_char) +- [is_generic_type_name](#is_generic_type_name) +- [is_name_char](#is_name_char) +- [join_env_vflags_and_os_args](#join_env_vflags_and_os_args) +- [launch_tool](#launch_tool) +- [module_is_builtin](#module_is_builtin) +- [new_error_manager](#new_error_manager) +- [new_suggestion](#new_suggestion) +- [new_surrounder](#new_surrounder) +- [new_timers](#new_timers) +- [no_cur_mod](#no_cur_mod) +- [no_dots](#no_dots) +- [path_of_executable](#path_of_executable) +- [path_styled_for_error_messages](#path_styled_for_error_messages) +- [prepare_tool_when_needed](#prepare_tool_when_needed) +- [qualify_import](#qualify_import) +- [qualify_module](#qualify_module) +- [quote_path](#quote_path) +- [read_file](#read_file) +- [recompile_file](#recompile_file) +- [replace_op](#replace_op) +- [resolve_d_value](#resolve_d_value) +- [resolve_env_value](#resolve_env_value) +- [resolve_vmodroot](#resolve_vmodroot) +- [set_source_for_path](#set_source_for_path) +- [set_vroot_folder](#set_vroot_folder) +- [short_module_name](#short_module_name) +- [should_bundle_module](#should_bundle_module) +- [should_recompile_tool](#should_recompile_tool) +- [show_compiler_message](#show_compiler_message) +- [skip_bom](#skip_bom) +- [smart_quote](#smart_quote) +- [source_file_context](#source_file_context) +- [strip_main_name](#strip_main_name) +- [strip_mod_name](#strip_mod_name) +- [tabs](#tabs) +- [timing_measure](#timing_measure) +- [timing_measure_cumulative](#timing_measure_cumulative) +- [timing_set_should_print](#timing_set_should_print) +- [timing_start](#timing_start) +- [verror](#verror) +- [vlines_escape_path](#vlines_escape_path) +- [CalculateSuggestionSimilarityFN](#CalculateSuggestionSimilarityFN) +- [Suggestion](#Suggestion) + - [add](#add) + - [add_many](#add_many) + - [sort](#sort) + - [say](#say) +- [EManager](#EManager) + - [set_support_color](#set_support_color) +- [SuggestionParams](#SuggestionParams) +- [Surrounder](#Surrounder) + - [add](#add) + - [before](#before) + - [after](#after) + - [builder_write_befores](#builder_write_befores) + - [builder_write_afters](#builder_write_afters) + - [free](#free) +- [TimerParams](#TimerParams) +- [Timers](#Timers) + - [start](#start) + - [measure](#measure) + - [measure_cumulative](#measure_cumulative) + - [measure_pause](#measure_pause) + - [measure_resume](#measure_resume) + - [message](#message) + - [show](#show) + - [show_if_exists](#show_if_exists) + - [show_remaining](#show_remaining) + - [dump_all](#dump_all) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## args_quote_paths +[[Return to contents]](#Contents) + +## bold +[[Return to contents]](#Contents) + +## cached_file2sourcelines +[[Return to contents]](#Contents) + +## cached_read_source_file +[[Return to contents]](#Contents) + +## cescaped_path +[[Return to contents]](#Contents) + +## check_module_is_installed +[[Return to contents]](#Contents) + +## color +[[Return to contents]](#Contents) + +## contains_capital +[[Return to contents]](#Contents) + +## ensure_modules_for_all_tools_are_installed +[[Return to contents]](#Contents) + +## find_all_v_files +[[Return to contents]](#Contents) + +## formatted_error +[[Return to contents]](#Contents) + +## free_caches +[[Return to contents]](#Contents) + +## get_build_time +[[Return to contents]](#Contents) + +## get_timers +[[Return to contents]](#Contents) + +## get_vtmp_folder +[[Return to contents]](#Contents) + +## good_type_name +[[Return to contents]](#Contents) + +## highlight_suggestion +[[Return to contents]](#Contents) + +## is_escape_sequence +[[Return to contents]](#Contents) + +## is_func_char +[[Return to contents]](#Contents) + +## is_generic_type_name +[[Return to contents]](#Contents) + +## is_name_char +[[Return to contents]](#Contents) + +## join_env_vflags_and_os_args +[[Return to contents]](#Contents) + +## launch_tool +[[Return to contents]](#Contents) + +## module_is_builtin +[[Return to contents]](#Contents) + +## new_error_manager +[[Return to contents]](#Contents) + +## new_suggestion +[[Return to contents]](#Contents) + +## new_surrounder +[[Return to contents]](#Contents) + +## new_timers +[[Return to contents]](#Contents) + +## no_cur_mod +[[Return to contents]](#Contents) + +## no_dots +[[Return to contents]](#Contents) + +## path_of_executable +[[Return to contents]](#Contents) + +## path_styled_for_error_messages +[[Return to contents]](#Contents) + +## prepare_tool_when_needed +[[Return to contents]](#Contents) + +## qualify_import +[[Return to contents]](#Contents) + +## qualify_module +[[Return to contents]](#Contents) + +## quote_path +[[Return to contents]](#Contents) + +## read_file +[[Return to contents]](#Contents) + +## recompile_file +[[Return to contents]](#Contents) + +## replace_op +[[Return to contents]](#Contents) + +## resolve_d_value +[[Return to contents]](#Contents) + +## resolve_env_value +[[Return to contents]](#Contents) + +## resolve_vmodroot +[[Return to contents]](#Contents) + +## set_source_for_path +[[Return to contents]](#Contents) + +## set_vroot_folder +[[Return to contents]](#Contents) + +## short_module_name +[[Return to contents]](#Contents) + +## should_bundle_module +[[Return to contents]](#Contents) + +## should_recompile_tool +[[Return to contents]](#Contents) + +## show_compiler_message +[[Return to contents]](#Contents) + +## skip_bom +[[Return to contents]](#Contents) + +## smart_quote +[[Return to contents]](#Contents) + +## source_file_context +[[Return to contents]](#Contents) + +## strip_main_name +[[Return to contents]](#Contents) + +## strip_mod_name +[[Return to contents]](#Contents) + +## tabs +[[Return to contents]](#Contents) + +## timing_measure +[[Return to contents]](#Contents) + +## timing_measure_cumulative +[[Return to contents]](#Contents) + +## timing_set_should_print +[[Return to contents]](#Contents) + +## timing_start +[[Return to contents]](#Contents) + +## verror +[[Return to contents]](#Contents) + +## vlines_escape_path +[[Return to contents]](#Contents) + +## CalculateSuggestionSimilarityFN +[[Return to contents]](#Contents) + +## Suggestion +## add +[[Return to contents]](#Contents) + +## add_many +[[Return to contents]](#Contents) + +## sort +[[Return to contents]](#Contents) + +## say +[[Return to contents]](#Contents) + +## EManager +[[Return to contents]](#Contents) + +## set_support_color +[[Return to contents]](#Contents) + +## SuggestionParams +[[Return to contents]](#Contents) + +## Surrounder +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## before +[[Return to contents]](#Contents) + +## after +[[Return to contents]](#Contents) + +## builder_write_befores +[[Return to contents]](#Contents) + +## builder_write_afters +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## TimerParams +[[Return to contents]](#Contents) + +## Timers +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +## measure +[[Return to contents]](#Contents) + +## measure_cumulative +[[Return to contents]](#Contents) + +## measure_pause +[[Return to contents]](#Contents) + +## measure_resume +[[Return to contents]](#Contents) + +## message +[[Return to contents]](#Contents) + +## show +[[Return to contents]](#Contents) + +## show_if_exists +[[Return to contents]](#Contents) + +## show_remaining +[[Return to contents]](#Contents) + +## dump_all +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.util.recompilation.md b/vdocs/v.util.recompilation.md new file mode 100644 index 00000000..b93cebc7 --- /dev/null +++ b/vdocs/v.util.recompilation.md @@ -0,0 +1,14 @@ +# module v.util.recompilation + + +## Contents +- [disabling_file](#disabling_file) +- [must_be_enabled](#must_be_enabled) + +## disabling_file +[[Return to contents]](#Contents) + +## must_be_enabled +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.util.version.md b/vdocs/v.util.version.md new file mode 100644 index 00000000..7f29ff9a --- /dev/null +++ b/vdocs/v.util.version.md @@ -0,0 +1,26 @@ +# module v.util.version + + +## Contents +- [Constants](#Constants) +- [full_hash](#full_hash) +- [full_v_version](#full_v_version) +- [githash](#githash) +- [vhash](#vhash) + +## Constants +[[Return to contents]](#Contents) + +## full_hash +[[Return to contents]](#Contents) + +## full_v_version +[[Return to contents]](#Contents) + +## githash +[[Return to contents]](#Contents) + +## vhash +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.util.vflags.md b/vdocs/v.util.vflags.md new file mode 100644 index 00000000..781bf1b6 --- /dev/null +++ b/vdocs/v.util.vflags.md @@ -0,0 +1,14 @@ +# module v.util.vflags + + +## Contents +- [join_env_vflags_and_os_args](#join_env_vflags_and_os_args) +- [tokenize_to_args](#tokenize_to_args) + +## join_env_vflags_and_os_args +[[Return to contents]](#Contents) + +## tokenize_to_args +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.util.vtest.md b/vdocs/v.util.vtest.md new file mode 100644 index 00000000..6f6c7df3 --- /dev/null +++ b/vdocs/v.util.vtest.md @@ -0,0 +1,14 @@ +# module v.util.vtest + + +## Contents +- [filter_vtest_only](#filter_vtest_only) +- [FilterVTestConfig](#FilterVTestConfig) + +## filter_vtest_only +[[Return to contents]](#Contents) + +## FilterVTestConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.vcache.md b/vdocs/v.vcache.md new file mode 100644 index 00000000..ad835f42 --- /dev/null +++ b/vdocs/v.vcache.md @@ -0,0 +1,58 @@ +# module v.vcache + + +## Contents +- [dlog](#dlog) +- [new_cache_manager](#new_cache_manager) +- [CacheManager](#CacheManager) + - [set_temporary_options](#set_temporary_options) + - [key2cpath](#key2cpath) + - [postfix_with_key2cpath](#postfix_with_key2cpath) + - [mod_postfix_with_key2cpath](#mod_postfix_with_key2cpath) + - [exists](#exists) + - [mod_exists](#mod_exists) + - [save](#save) + - [mod_save](#mod_save) + - [load](#load) + - [mod_load](#mod_load) + +## dlog +[[Return to contents]](#Contents) + +## new_cache_manager +[[Return to contents]](#Contents) + +## CacheManager +[[Return to contents]](#Contents) + +## set_temporary_options +[[Return to contents]](#Contents) + +## key2cpath +[[Return to contents]](#Contents) + +## postfix_with_key2cpath +[[Return to contents]](#Contents) + +## mod_postfix_with_key2cpath +[[Return to contents]](#Contents) + +## exists +[[Return to contents]](#Contents) + +## mod_exists +[[Return to contents]](#Contents) + +## save +[[Return to contents]](#Contents) + +## mod_save +[[Return to contents]](#Contents) + +## load +[[Return to contents]](#Contents) + +## mod_load +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v.vmod.md b/vdocs/v.vmod.md new file mode 100644 index 00000000..95428878 --- /dev/null +++ b/vdocs/v.vmod.md @@ -0,0 +1,46 @@ +# module v.vmod + + +## Contents +- [decode](#decode) +- [from_file](#from_file) +- [get_cache](#get_cache) +- [new_mod_file_cacher](#new_mod_file_cacher) +- [Manifest](#Manifest) +- [ModFileAndFolder](#ModFileAndFolder) +- [ModFileCacher](#ModFileCacher) + - [debug](#debug) + - [get_by_file](#get_by_file) + - [get_by_folder](#get_by_folder) + +## decode +[[Return to contents]](#Contents) + +## from_file +[[Return to contents]](#Contents) + +## get_cache +[[Return to contents]](#Contents) + +## new_mod_file_cacher +[[Return to contents]](#Contents) + +## Manifest +[[Return to contents]](#Contents) + +## ModFileAndFolder +[[Return to contents]](#Contents) + +## ModFileCacher +[[Return to contents]](#Contents) + +## debug +[[Return to contents]](#Contents) + +## get_by_file +[[Return to contents]](#Contents) + +## get_by_folder +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.ast.md b/vdocs/v2.ast.md new file mode 100644 index 00000000..be22ae04 --- /dev/null +++ b/vdocs/v2.ast.md @@ -0,0 +1,416 @@ +# module v2.ast + + +## Contents +- [Constants](#Constants) +- [StringInterFormat.from_u8](#StringInterFormat.from_u8) +- [StringLiteralKind.from_string_tinyv](#StringLiteralKind.from_string_tinyv) +- [Expr](#Expr) + - [name](#name) + - [pos](#pos) +- [Stmt](#Stmt) +- [Type](#Type) + - [name](#name) +- [[]Attribute](#[]Attribute) + - [has](#has) +- [[]Expr](#[]Expr) + - [name_list](#name_list) +- [Language](#Language) + - [str](#str) +- [StringInterFormat](#StringInterFormat) + - [str](#str) +- [StringLiteralKind](#StringLiteralKind) + - [str](#str) +- [AnonStructType](#AnonStructType) +- [ArrayFixedType](#ArrayFixedType) +- [ArrayInitExpr](#ArrayInitExpr) +- [ArrayType](#ArrayType) +- [AsCastExpr](#AsCastExpr) +- [AsmStmt](#AsmStmt) +- [AssertStmt](#AssertStmt) +- [AssignStmt](#AssignStmt) +- [AssocExpr](#AssocExpr) +- [Attribute](#Attribute) +- [BasicLiteral](#BasicLiteral) +- [BlockStmt](#BlockStmt) +- [CallExpr](#CallExpr) +- [CallOrCastExpr](#CallOrCastExpr) +- [CastExpr](#CastExpr) +- [ChannelType](#ChannelType) +- [ComptimeExpr](#ComptimeExpr) +- [ComptimeStmt](#ComptimeStmt) +- [ConstDecl](#ConstDecl) +- [DeferStmt](#DeferStmt) +- [Directive](#Directive) +- [EnumDecl](#EnumDecl) +- [ExprStmt](#ExprStmt) +- [FieldDecl](#FieldDecl) +- [FieldInit](#FieldInit) +- [File](#File) +- [FlowControlStmt](#FlowControlStmt) +- [FnDecl](#FnDecl) +- [FnLiteral](#FnLiteral) +- [FnType](#FnType) + - [str](#str) +- [ForInStmt](#ForInStmt) +- [ForStmt](#ForStmt) +- [GenericArgOrIndexExpr](#GenericArgOrIndexExpr) +- [GenericArgs](#GenericArgs) +- [GenericType](#GenericType) +- [GlobalDecl](#GlobalDecl) +- [Ident](#Ident) + - [str](#str) +- [IfExpr](#IfExpr) +- [IfGuardExpr](#IfGuardExpr) +- [ImportStmt](#ImportStmt) +- [IndexExpr](#IndexExpr) +- [InfixExpr](#InfixExpr) +- [InitExpr](#InitExpr) +- [InterfaceDecl](#InterfaceDecl) +- [Keyword](#Keyword) +- [KeywordOperator](#KeywordOperator) +- [LabelStmt](#LabelStmt) +- [LambdaExpr](#LambdaExpr) +- [LockExpr](#LockExpr) +- [MapInitExpr](#MapInitExpr) +- [MapType](#MapType) +- [MatchBranch](#MatchBranch) +- [MatchExpr](#MatchExpr) + - [desugar](#desugar) +- [ModifierExpr](#ModifierExpr) +- [ModuleStmt](#ModuleStmt) +- [NilType](#NilType) +- [NoneType](#NoneType) +- [OptionType](#OptionType) +- [OrExpr](#OrExpr) + - [desugar](#desugar) +- [Parameter](#Parameter) +- [ParenExpr](#ParenExpr) +- [PostfixExpr](#PostfixExpr) +- [PrefixExpr](#PrefixExpr) +- [RangeExpr](#RangeExpr) +- [ResultType](#ResultType) +- [ReturnStmt](#ReturnStmt) +- [SelectExpr](#SelectExpr) +- [SelectorExpr](#SelectorExpr) + - [leftmost](#leftmost) + - [name](#name) +- [SqlExpr](#SqlExpr) +- [StringInter](#StringInter) +- [StringInterLiteral](#StringInterLiteral) +- [StringLiteral](#StringLiteral) +- [StructDecl](#StructDecl) +- [ThreadType](#ThreadType) +- [Tuple](#Tuple) +- [TupleType](#TupleType) +- [TypeDecl](#TypeDecl) +- [UnsafeExpr](#UnsafeExpr) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## StringInterFormat.from_u8 +[[Return to contents]](#Contents) + +## StringLiteralKind.from_string_tinyv +[[Return to contents]](#Contents) + +## Expr +[[Return to contents]](#Contents) + +## name +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +## Stmt +[[Return to contents]](#Contents) + +## Type +[[Return to contents]](#Contents) + +## name +[[Return to contents]](#Contents) + +## []Attribute +## has +[[Return to contents]](#Contents) + +## []Expr +## name_list +[[Return to contents]](#Contents) + +## Language +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## StringInterFormat +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## StringLiteralKind +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## AnonStructType +[[Return to contents]](#Contents) + +## ArrayFixedType +[[Return to contents]](#Contents) + +## ArrayInitExpr +[[Return to contents]](#Contents) + +## ArrayType +[[Return to contents]](#Contents) + +## AsCastExpr +[[Return to contents]](#Contents) + +## AsmStmt +[[Return to contents]](#Contents) + +## AssertStmt +[[Return to contents]](#Contents) + +## AssignStmt +[[Return to contents]](#Contents) + +## AssocExpr +[[Return to contents]](#Contents) + +## Attribute +[[Return to contents]](#Contents) + +## BasicLiteral +[[Return to contents]](#Contents) + +## BlockStmt +[[Return to contents]](#Contents) + +## CallExpr +[[Return to contents]](#Contents) + +## CallOrCastExpr +[[Return to contents]](#Contents) + +## CastExpr +[[Return to contents]](#Contents) + +## ChannelType +[[Return to contents]](#Contents) + +## ComptimeExpr +[[Return to contents]](#Contents) + +## ComptimeStmt +[[Return to contents]](#Contents) + +## ConstDecl +[[Return to contents]](#Contents) + +## DeferStmt +[[Return to contents]](#Contents) + +## Directive +[[Return to contents]](#Contents) + +## EnumDecl +[[Return to contents]](#Contents) + +## ExprStmt +[[Return to contents]](#Contents) + +## FieldDecl +[[Return to contents]](#Contents) + +## FieldInit +[[Return to contents]](#Contents) + +## File +[[Return to contents]](#Contents) + +## FlowControlStmt +[[Return to contents]](#Contents) + +## FnDecl +[[Return to contents]](#Contents) + +## FnLiteral +[[Return to contents]](#Contents) + +## FnType +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## ForInStmt +[[Return to contents]](#Contents) + +## ForStmt +[[Return to contents]](#Contents) + +## GenericArgOrIndexExpr +[[Return to contents]](#Contents) + +## GenericArgs +[[Return to contents]](#Contents) + +## GenericType +[[Return to contents]](#Contents) + +## GlobalDecl +[[Return to contents]](#Contents) + +## Ident +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## IfExpr +[[Return to contents]](#Contents) + +## IfGuardExpr +[[Return to contents]](#Contents) + +## ImportStmt +[[Return to contents]](#Contents) + +## IndexExpr +[[Return to contents]](#Contents) + +## InfixExpr +[[Return to contents]](#Contents) + +## InitExpr +[[Return to contents]](#Contents) + +## InterfaceDecl +[[Return to contents]](#Contents) + +## Keyword +[[Return to contents]](#Contents) + +## KeywordOperator +[[Return to contents]](#Contents) + +## LabelStmt +[[Return to contents]](#Contents) + +## LambdaExpr +[[Return to contents]](#Contents) + +## LockExpr +[[Return to contents]](#Contents) + +## MapInitExpr +[[Return to contents]](#Contents) + +## MapType +[[Return to contents]](#Contents) + +## MatchBranch +[[Return to contents]](#Contents) + +## MatchExpr +[[Return to contents]](#Contents) + +## desugar +[[Return to contents]](#Contents) + +## ModifierExpr +[[Return to contents]](#Contents) + +## ModuleStmt +[[Return to contents]](#Contents) + +## NilType +[[Return to contents]](#Contents) + +## NoneType +[[Return to contents]](#Contents) + +## OptionType +[[Return to contents]](#Contents) + +## OrExpr +[[Return to contents]](#Contents) + +## desugar +[[Return to contents]](#Contents) + +## Parameter +[[Return to contents]](#Contents) + +## ParenExpr +[[Return to contents]](#Contents) + +## PostfixExpr +[[Return to contents]](#Contents) + +## PrefixExpr +[[Return to contents]](#Contents) + +## RangeExpr +[[Return to contents]](#Contents) + +## ResultType +[[Return to contents]](#Contents) + +## ReturnStmt +[[Return to contents]](#Contents) + +## SelectExpr +[[Return to contents]](#Contents) + +## SelectorExpr +[[Return to contents]](#Contents) + +## leftmost +[[Return to contents]](#Contents) + +## name +[[Return to contents]](#Contents) + +## SqlExpr +[[Return to contents]](#Contents) + +## StringInter +[[Return to contents]](#Contents) + +## StringInterLiteral +[[Return to contents]](#Contents) + +## StringLiteral +[[Return to contents]](#Contents) + +## StructDecl +[[Return to contents]](#Contents) + +## ThreadType +[[Return to contents]](#Contents) + +## Tuple +[[Return to contents]](#Contents) + +## TupleType +[[Return to contents]](#Contents) + +## TypeDecl +[[Return to contents]](#Contents) + +## UnsafeExpr +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.builder.md b/vdocs/v2.builder.md new file mode 100644 index 00000000..23e3715c --- /dev/null +++ b/vdocs/v2.builder.md @@ -0,0 +1,16 @@ +# module v2.builder + + +## Contents +- [new_builder](#new_builder) +- [Builder](#Builder) + - [build](#build) + +## new_builder +[[Return to contents]](#Contents) + +## Builder +## build +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.errors.md b/vdocs/v2.errors.md new file mode 100644 index 00000000..6f7c8f7b --- /dev/null +++ b/vdocs/v2.errors.md @@ -0,0 +1,46 @@ +# module v2.errors + + +## Contents +- [details](#details) +- [error](#error) +- [Kind](#Kind) + - [str](#str) + - [color](#color) +- [Reporter](#Reporter) +- [CompilerMessage](#CompilerMessage) +- [Error](#Error) +- [Notice](#Notice) +- [Warning](#Warning) + +## details +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## Kind +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## color +[[Return to contents]](#Contents) + +## Reporter +[[Return to contents]](#Contents) + +## CompilerMessage +[[Return to contents]](#Contents) + +## Error +[[Return to contents]](#Contents) + +## Notice +[[Return to contents]](#Contents) + +## Warning +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.gen.v.md b/vdocs/v2.gen.v.md new file mode 100644 index 00000000..68a29cf4 --- /dev/null +++ b/vdocs/v2.gen.v.md @@ -0,0 +1,24 @@ +# module v2.gen.v + + +## Contents +- [new_gen](#new_gen) +- [Gen](#Gen) + - [reset](#reset) + - [gen](#gen) + - [print_output](#print_output) + +## new_gen +[[Return to contents]](#Contents) + +## Gen +## reset +[[Return to contents]](#Contents) + +## gen +[[Return to contents]](#Contents) + +## print_output +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.parser.md b/vdocs/v2.parser.md new file mode 100644 index 00000000..4c35f3b5 --- /dev/null +++ b/vdocs/v2.parser.md @@ -0,0 +1,26 @@ +# module v2.parser + + +## Contents +- [Parser.new](#Parser.new) +- [Parser](#Parser) + - [parse_files](#parse_files) + - [parse_file](#parse_file) + - [expect_semi](#expect_semi) + +## Parser.new +[[Return to contents]](#Contents) + +## Parser +[[Return to contents]](#Contents) + +## parse_files +[[Return to contents]](#Contents) + +## parse_file +[[Return to contents]](#Contents) + +## expect_semi +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.pref.md b/vdocs/v2.pref.md new file mode 100644 index 00000000..1f639dcd --- /dev/null +++ b/vdocs/v2.pref.md @@ -0,0 +1,26 @@ +# module v2.pref + + +## Contents +- [new_preferences](#new_preferences) +- [new_preferences_using_options](#new_preferences_using_options) +- [Preferences](#Preferences) + - [get_module_path](#get_module_path) + - [get_vlib_module_path](#get_vlib_module_path) + +## new_preferences +[[Return to contents]](#Contents) + +## new_preferences_using_options +[[Return to contents]](#Contents) + +## Preferences +[[Return to contents]](#Contents) + +## get_module_path +[[Return to contents]](#Contents) + +## get_vlib_module_path +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.scanner.md b/vdocs/v2.scanner.md new file mode 100644 index 00000000..2a8555ba --- /dev/null +++ b/vdocs/v2.scanner.md @@ -0,0 +1,26 @@ +# module v2.scanner + + +## Contents +- [new_scanner](#new_scanner) +- [Mode](#Mode) +- [Scanner](#Scanner) + - [init](#init) + - [scan](#scan) + +## new_scanner +[[Return to contents]](#Contents) + +## Mode +[[Return to contents]](#Contents) + +## Scanner +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## scan +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.token.md b/vdocs/v2.token.md new file mode 100644 index 00000000..3e4d091d --- /dev/null +++ b/vdocs/v2.token.md @@ -0,0 +1,114 @@ +# module v2.token + + +## Contents +- [FileSet.new](#FileSet.new) +- [Token.from_string_tinyv](#Token.from_string_tinyv) +- [BindingPower](#BindingPower) +- [Token](#Token) + - [left_binding_power](#left_binding_power) + - [right_binding_power](#right_binding_power) + - [is_prefix](#is_prefix) + - [is_infix](#is_infix) + - [is_postfix](#is_postfix) + - [is_assignment](#is_assignment) + - [is_overloadable](#is_overloadable) + - [is_comparison](#is_comparison) + - [str](#str) +- [File](#File) + - [add_line](#add_line) + - [line_count](#line_count) + - [line_start](#line_start) + - [line](#line) + - [pos](#pos) + - [position](#position) + - [find_line_and_column](#find_line_and_column) + - [find_line](#find_line) +- [FileSet](#FileSet) + - [add_file](#add_file) + - [file](#file) +- [Position](#Position) + - [str](#str) + +## FileSet.new +[[Return to contents]](#Contents) + +## Token.from_string_tinyv +[[Return to contents]](#Contents) + +## BindingPower +[[Return to contents]](#Contents) + +## Token +[[Return to contents]](#Contents) + +## left_binding_power +[[Return to contents]](#Contents) + +## right_binding_power +[[Return to contents]](#Contents) + +## is_prefix +[[Return to contents]](#Contents) + +## is_infix +[[Return to contents]](#Contents) + +## is_postfix +[[Return to contents]](#Contents) + +## is_assignment +[[Return to contents]](#Contents) + +## is_overloadable +[[Return to contents]](#Contents) + +## is_comparison +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## File +[[Return to contents]](#Contents) + +## add_line +[[Return to contents]](#Contents) + +## line_count +[[Return to contents]](#Contents) + +## line_start +[[Return to contents]](#Contents) + +## line +[[Return to contents]](#Contents) + +## pos +[[Return to contents]](#Contents) + +## position +[[Return to contents]](#Contents) + +## find_line_and_column +[[Return to contents]](#Contents) + +## find_line +[[Return to contents]](#Contents) + +## FileSet +[[Return to contents]](#Contents) + +## add_file +[[Return to contents]](#Contents) + +## file +[[Return to contents]](#Contents) + +## Position +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.types.md b/vdocs/v2.types.md new file mode 100644 index 00000000..a91e2737 --- /dev/null +++ b/vdocs/v2.types.md @@ -0,0 +1,84 @@ +# module v2.types + + +## Contents +- [init_universe](#init_universe) +- [new_module](#new_module) +- [new_scope](#new_scope) +- [Checker.new](#Checker.new) +- [Environment.new](#Environment.new) +- [Checker](#Checker) + - [get_module_scope](#get_module_scope) + - [check_files](#check_files) + - [check_file](#check_file) +- [Object](#Object) + - [typ](#typ) +- [Type](#Type) +- [Module](#Module) +- [Scope](#Scope) + - [lookup_field_smartcast](#lookup_field_smartcast) + - [lookup](#lookup) + - [lookup_parent](#lookup_parent) + - [lookup_parent_with_scope](#lookup_parent_with_scope) + - [insert](#insert) + - [print](#print) + +## init_universe +[[Return to contents]](#Contents) + +## new_module +[[Return to contents]](#Contents) + +## new_scope +[[Return to contents]](#Contents) + +## Checker.new +[[Return to contents]](#Contents) + +## Environment.new +[[Return to contents]](#Contents) + +## Checker +## get_module_scope +[[Return to contents]](#Contents) + +## check_files +[[Return to contents]](#Contents) + +## check_file +[[Return to contents]](#Contents) + +## Object +[[Return to contents]](#Contents) + +## typ +[[Return to contents]](#Contents) + +## Type +[[Return to contents]](#Contents) + +## Module +[[Return to contents]](#Contents) + +## Scope +[[Return to contents]](#Contents) + +## lookup_field_smartcast +[[Return to contents]](#Contents) + +## lookup +[[Return to contents]](#Contents) + +## lookup_parent +[[Return to contents]](#Contents) + +## lookup_parent_with_scope +[[Return to contents]](#Contents) + +## insert +[[Return to contents]](#Contents) + +## print +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/v2.util.md b/vdocs/v2.util.md new file mode 100644 index 00000000..8114407a --- /dev/null +++ b/vdocs/v2.util.md @@ -0,0 +1,48 @@ +# module v2.util + + +## Contents +- [WorkerPool.new](#WorkerPool.new) +- [WorkerPool[T,-Y]](#WorkerPool[T, Y]) + - [add_worker](#add_worker) + - [active_jobs](#active_jobs) + - [get_job](#get_job) + - [push_result](#push_result) + - [job_done](#job_done) + - [queue_job](#queue_job) + - [queue_jobs](#queue_jobs) + - [wait_for_results](#wait_for_results) +- [WorkerPool](#WorkerPool) + +## WorkerPool.new +[[Return to contents]](#Contents) + +## WorkerPool[T, Y] +## add_worker +[[Return to contents]](#Contents) + +## active_jobs +[[Return to contents]](#Contents) + +## get_job +[[Return to contents]](#Contents) + +## push_result +[[Return to contents]](#Contents) + +## job_done +[[Return to contents]](#Contents) + +## queue_job +[[Return to contents]](#Contents) + +## queue_jobs +[[Return to contents]](#Contents) + +## wait_for_results +[[Return to contents]](#Contents) + +## WorkerPool +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/veb.assets.md b/vdocs/veb.assets.md new file mode 100644 index 00000000..633f33d3 --- /dev/null +++ b/vdocs/veb.assets.md @@ -0,0 +1,65 @@ +# module veb.assets + + +## Contents +- [minify_css](#minify_css) +- [minify_js](#minify_js) +- [AssetType](#AssetType) +- [Asset](#Asset) +- [AssetManager](#AssetManager) + - [handle_assets](#handle_assets) + - [handle_assets_at](#handle_assets_at) + - [get_assets](#get_assets) + - [add](#add) + - [cleanup_cache](#cleanup_cache) + - [exists](#exists) + - [include](#include) + - [combine](#combine) + +## minify_css +[[Return to contents]](#Contents) + +## minify_js +[[Return to contents]](#Contents) + +## AssetType +[[Return to contents]](#Contents) + +## Asset +[[Return to contents]](#Contents) + +## AssetManager +[[Return to contents]](#Contents) + +## handle_assets +[[Return to contents]](#Contents) + +## handle_assets_at +[[Return to contents]](#Contents) + +## get_assets +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## cleanup_cache +[[Return to contents]](#Contents) + +## exists +[[Return to contents]](#Contents) + +## include +Example +```v + +@{app.am.include(.css, 'main.css')} + +``` + +[[Return to contents]](#Contents) + +## combine +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/veb.auth.md b/vdocs/veb.auth.md new file mode 100644 index 00000000..d416f035 --- /dev/null +++ b/vdocs/veb.auth.md @@ -0,0 +1,52 @@ +# module veb.auth + + +## Contents +- [compare_password_with_hash](#compare_password_with_hash) +- [generate_salt](#generate_salt) +- [hash_password_with_salt](#hash_password_with_salt) +- [new](#new) +- [set_rand_crypto_safe_seed](#set_rand_crypto_safe_seed) +- [Auth[T]](#Auth[T]) + - [add_token](#add_token) + - [find_token](#find_token) + - [delete_tokens](#delete_tokens) +- [Auth](#Auth) +- [Request](#Request) +- [Token](#Token) + +## compare_password_with_hash +[[Return to contents]](#Contents) + +## generate_salt +[[Return to contents]](#Contents) + +## hash_password_with_salt +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## set_rand_crypto_safe_seed +[[Return to contents]](#Contents) + +## Auth[T] +## add_token +[[Return to contents]](#Contents) + +## find_token +[[Return to contents]](#Contents) + +## delete_tokens +[[Return to contents]](#Contents) + +## Auth +[[Return to contents]](#Contents) + +## Request +[[Return to contents]](#Contents) + +## Token +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/veb.csrf.md b/vdocs/veb.csrf.md new file mode 100644 index 00000000..bdc5248e --- /dev/null +++ b/vdocs/veb.csrf.md @@ -0,0 +1,38 @@ +# module veb.csrf + + +## Contents +- [middleware](#middleware) +- [protect](#protect) +- [set_token](#set_token) +- [CsrfConfig](#CsrfConfig) +- [CsrfContext](#CsrfContext) + - [set_csrf_token](#set_csrf_token) + - [clear_csrf_token](#clear_csrf_token) + - [csrf_token_input](#csrf_token_input) + +## middleware +[[Return to contents]](#Contents) + +## protect +[[Return to contents]](#Contents) + +## set_token +[[Return to contents]](#Contents) + +## CsrfConfig +[[Return to contents]](#Contents) + +## CsrfContext +[[Return to contents]](#Contents) + +## set_csrf_token +[[Return to contents]](#Contents) + +## clear_csrf_token +[[Return to contents]](#Contents) + +## csrf_token_input +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/veb.md b/vdocs/veb.md new file mode 100644 index 00000000..d2704b39 --- /dev/null +++ b/vdocs/veb.md @@ -0,0 +1,331 @@ +# module veb + + +## Contents +- [Constants](#Constants) +- [controller](#controller) +- [controller_host](#controller_host) +- [cors](#cors) +- [decode_gzip](#decode_gzip) +- [encode_gzip](#encode_gzip) +- [no_result](#no_result) +- [raw](#raw) +- [run](#run) +- [run_at](#run_at) +- [tr](#tr) +- [tr_plural](#tr_plural) +- [StaticApp](#StaticApp) +- [FileResponse](#FileResponse) + - [done](#done) +- [MiddlewareHandler](#MiddlewareHandler) +- [Middleware[T]](#Middleware[T]) + - [str](#str) + - [use](#use) + - [route_use](#route_use) +- [RawHtml](#RawHtml) +- [RequestParams](#RequestParams) + - [request_done](#request_done) +- [StringResponse](#StringResponse) + - [done](#done) +- [RedirectType](#RedirectType) +- [Context](#Context) + - [before_request](#before_request) + - [error](#error) + - [file](#file) + - [get_cookie](#get_cookie) + - [get_custom_header](#get_custom_header) + - [get_header](#get_header) + - [html](#html) + - [ip](#ip) + - [json](#json) + - [json_pretty](#json_pretty) + - [no_content](#no_content) + - [not_found](#not_found) + - [ok](#ok) + - [redirect](#redirect) + - [request_error](#request_error) + - [send_response_to_client](#send_response_to_client) + - [server_error](#server_error) + - [set_content_type](#set_content_type) + - [set_cookie](#set_cookie) + - [set_custom_header](#set_custom_header) + - [set_header](#set_header) + - [takeover_conn](#takeover_conn) + - [text](#text) + - [user_agent](#user_agent) +- [Controller](#Controller) + - [register_controller](#register_controller) + - [register_host_controller](#register_host_controller) +- [ControllerPath](#ControllerPath) +- [CorsOptions](#CorsOptions) + - [set_headers](#set_headers) + - [validate_request](#validate_request) +- [Middleware](#Middleware) +- [MiddlewareOptions](#MiddlewareOptions) +- [RedirectParams](#RedirectParams) +- [Result](#Result) +- [RunParams](#RunParams) +- [StaticHandler](#StaticHandler) + - [handle_static](#handle_static) + - [host_handle_static](#host_handle_static) + - [mount_static_folder_at](#mount_static_folder_at) + - [host_mount_static_folder_at](#host_mount_static_folder_at) + - [serve_static](#serve_static) + - [host_serve_static](#host_serve_static) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## controller +[[Return to contents]](#Contents) + +## controller_host +[[Return to contents]](#Contents) + +## cors +Example +```v + +app.use(veb.cors[Context](veb.CorsOptions{ + origins: ['*'] + allowed_methods: [.get, .head, .patch, .put, .post, .delete] +})) + +``` + +[[Return to contents]](#Contents) + +## decode_gzip +Example +```v + +app.use(veb.decode_gzip[Context]()) + +``` + +[[Return to contents]](#Contents) + +## encode_gzip +Example +```v + +app.use(veb.encode_gzip[Context]()) + +``` + +[[Return to contents]](#Contents) + +## no_result +[[Return to contents]](#Contents) + +## raw +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## run_at +Example +```v + +veb.run_at(new_app(), veb.RunParams{ host: 'localhost' port: 8099 family: .ip }) or { panic(err) } + +``` + +[[Return to contents]](#Contents) + +## tr +[[Return to contents]](#Contents) + +## tr_plural +[[Return to contents]](#Contents) + +## StaticApp +[[Return to contents]](#Contents) + +## FileResponse +## done +[[Return to contents]](#Contents) + +## MiddlewareHandler +[[Return to contents]](#Contents) + +## Middleware[T] +## str +[[Return to contents]](#Contents) + +## use +[[Return to contents]](#Contents) + +## route_use +[[Return to contents]](#Contents) + +## RawHtml +[[Return to contents]](#Contents) + +## RequestParams +## request_done +[[Return to contents]](#Contents) + +## StringResponse +## done +[[Return to contents]](#Contents) + +## RedirectType +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## before_request +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## file +[[Return to contents]](#Contents) + +## get_cookie +[[Return to contents]](#Contents) + +## get_custom_header +[[Return to contents]](#Contents) + +## get_header +[[Return to contents]](#Contents) + +## html +[[Return to contents]](#Contents) + +## ip +[[Return to contents]](#Contents) + +## json +[[Return to contents]](#Contents) + +## json_pretty +[[Return to contents]](#Contents) + +## no_content +[[Return to contents]](#Contents) + +## not_found +[[Return to contents]](#Contents) + +## ok +[[Return to contents]](#Contents) + +## redirect +[[Return to contents]](#Contents) + +## request_error +[[Return to contents]](#Contents) + +## send_response_to_client +[[Return to contents]](#Contents) + +## server_error +[[Return to contents]](#Contents) + +## set_content_type +[[Return to contents]](#Contents) + +## set_cookie +[[Return to contents]](#Contents) + +## set_custom_header +[[Return to contents]](#Contents) + +## set_header +[[Return to contents]](#Contents) + +## takeover_conn +[[Return to contents]](#Contents) + +## text +[[Return to contents]](#Contents) + +## user_agent +[[Return to contents]](#Contents) + +## Controller +[[Return to contents]](#Contents) + +## register_controller +[[Return to contents]](#Contents) + +## register_host_controller +[[Return to contents]](#Contents) + +## ControllerPath +[[Return to contents]](#Contents) + +## CorsOptions +[[Return to contents]](#Contents) + +## set_headers +[[Return to contents]](#Contents) + +## validate_request +[[Return to contents]](#Contents) + +## Middleware +[[Return to contents]](#Contents) + +## MiddlewareOptions +[[Return to contents]](#Contents) + +## RedirectParams +[[Return to contents]](#Contents) + +## Result +[[Return to contents]](#Contents) + +## RunParams +[[Return to contents]](#Contents) + +## StaticHandler +[[Return to contents]](#Contents) + +## handle_static +[[Return to contents]](#Contents) + +## host_handle_static +[[Return to contents]](#Contents) + +## mount_static_folder_at +[[Return to contents]](#Contents) + +## host_mount_static_folder_at +[[Return to contents]](#Contents) + +## serve_static +[[Return to contents]](#Contents) + +## host_serve_static +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/veb.oauth.md b/vdocs/veb.oauth.md new file mode 100644 index 00000000..5622afc9 --- /dev/null +++ b/vdocs/veb.oauth.md @@ -0,0 +1,22 @@ +# module veb.oauth + + +## Contents +- [TokenPostType](#TokenPostType) +- [Context](#Context) + - [get_token](#get_token) +- [Request](#Request) + +## TokenPostType +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## get_token +[[Return to contents]](#Contents) + +## Request +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/veb.sse.md b/vdocs/veb.sse.md new file mode 100644 index 00000000..d3979953 --- /dev/null +++ b/vdocs/veb.sse.md @@ -0,0 +1,26 @@ +# module veb.sse + + +## Contents +- [start_connection](#start_connection) +- [SSEConnection](#SSEConnection) + - [send_message](#send_message) + - [close](#close) +- [SSEMessage](#SSEMessage) + +## start_connection +[[Return to contents]](#Contents) + +## SSEConnection +[[Return to contents]](#Contents) + +## send_message +[[Return to contents]](#Contents) + +## close +[[Return to contents]](#Contents) + +## SSEMessage +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/vweb.assets.md b/vdocs/vweb.assets.md new file mode 100644 index 00000000..3ccfe6db --- /dev/null +++ b/vdocs/vweb.assets.md @@ -0,0 +1,58 @@ +# module vweb.assets + + +## Contents +- [minify_css](#minify_css) +- [minify_js](#minify_js) +- [new_manager](#new_manager) +- [AssetManager](#AssetManager) + - [add_css](#add_css) + - [add_css_as](#add_css_as) + - [add_js](#add_js) + - [add_js_as](#add_js_as) + - [combine_css](#combine_css) + - [combine_js](#combine_js) + - [include_css](#include_css) + - [include_js](#include_js) + - [add](#add) + +## minify_css +[[Return to contents]](#Contents) + +## minify_js +[[Return to contents]](#Contents) + +## new_manager +[[Return to contents]](#Contents) + +## AssetManager +[[Return to contents]](#Contents) + +## add_css +[[Return to contents]](#Contents) + +## add_css_as +[[Return to contents]](#Contents) + +## add_js +[[Return to contents]](#Contents) + +## add_js_as +[[Return to contents]](#Contents) + +## combine_css +[[Return to contents]](#Contents) + +## combine_js +[[Return to contents]](#Contents) + +## include_css +[[Return to contents]](#Contents) + +## include_js +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/vweb.csrf.md b/vdocs/vweb.csrf.md new file mode 100644 index 00000000..e2d7df9a --- /dev/null +++ b/vdocs/vweb.csrf.md @@ -0,0 +1,34 @@ +# module vweb.csrf + + +## Contents +- [middleware](#middleware) +- [protect](#protect) +- [set_token](#set_token) +- [CsrfApp](#CsrfApp) + - [set_token](#set_token) + - [protect](#protect) +- [CsrfConfig](#CsrfConfig) + +## middleware +[[Return to contents]](#Contents) + +## protect +[[Return to contents]](#Contents) + +## set_token +[[Return to contents]](#Contents) + +## CsrfApp +[[Return to contents]](#Contents) + +## set_token +[[Return to contents]](#Contents) + +## protect +[[Return to contents]](#Contents) + +## CsrfConfig +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/vweb.md b/vdocs/vweb.md new file mode 100644 index 00000000..38ac10ba --- /dev/null +++ b/vdocs/vweb.md @@ -0,0 +1,223 @@ +# module vweb + + +## Contents +- [Constants](#Constants) +- [controller](#controller) +- [controller_host](#controller_host) +- [database_pool](#database_pool) +- [not_found](#not_found) +- [run](#run) +- [run_at](#run_at) +- [DatabasePool](#DatabasePool) +- [Middleware](#Middleware) +- [RawHtml](#RawHtml) +- [Context](#Context) + - [init_server](#init_server) + - [before_accept_loop](#before_accept_loop) + - [before_request](#before_request) + - [send_response_to_client](#send_response_to_client) + - [html](#html) + - [text](#text) + - [json](#json) + - [json_pretty](#json_pretty) + - [file](#file) + - [ok](#ok) + - [server_error](#server_error) + - [redirect](#redirect) + - [not_found](#not_found) + - [set_cookie](#set_cookie) + - [set_content_type](#set_content_type) + - [set_cookie_with_expire_date](#set_cookie_with_expire_date) + - [get_cookie](#get_cookie) + - [set_status](#set_status) + - [add_header](#add_header) + - [get_header](#get_header) + - [set_value](#set_value) + - [get_value](#get_value) + - [handle_static](#handle_static) + - [host_handle_static](#host_handle_static) + - [mount_static_folder_at](#mount_static_folder_at) + - [host_mount_static_folder_at](#host_mount_static_folder_at) + - [serve_static](#serve_static) + - [host_serve_static](#host_serve_static) + - [user_agent](#user_agent) + - [ip](#ip) + - [error](#error) +- [Controller](#Controller) +- [ControllerPath](#ControllerPath) +- [PoolParams](#PoolParams) +- [RedirectParams](#RedirectParams) +- [Result](#Result) +- [RunParams](#RunParams) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## controller +[[Return to contents]](#Contents) + +## controller_host +[[Return to contents]](#Contents) + +## database_pool +[[Return to contents]](#Contents) + +## not_found +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## run_at +Example +```v + +vweb.run_at(new_app(), vweb.RunParams{ host: 'localhost' port: 8099 family: .ip }) or { panic(err) } + +``` + +[[Return to contents]](#Contents) + +## DatabasePool +[[Return to contents]](#Contents) + +## Middleware +[[Return to contents]](#Contents) + +## RawHtml +[[Return to contents]](#Contents) + +## Context +[[Return to contents]](#Contents) + +## init_server +[[Return to contents]](#Contents) + +## before_accept_loop +[[Return to contents]](#Contents) + +## before_request +[[Return to contents]](#Contents) + +## send_response_to_client +[[Return to contents]](#Contents) + +## html +[[Return to contents]](#Contents) + +## text +[[Return to contents]](#Contents) + +## json +[[Return to contents]](#Contents) + +## json_pretty +[[Return to contents]](#Contents) + +## file +[[Return to contents]](#Contents) + +## ok +[[Return to contents]](#Contents) + +## server_error +[[Return to contents]](#Contents) + +## redirect +[[Return to contents]](#Contents) + +## not_found +[[Return to contents]](#Contents) + +## set_cookie +[[Return to contents]](#Contents) + +## set_content_type +[[Return to contents]](#Contents) + +## set_cookie_with_expire_date +[[Return to contents]](#Contents) + +## get_cookie +[[Return to contents]](#Contents) + +## set_status +[[Return to contents]](#Contents) + +## add_header +[[Return to contents]](#Contents) + +## get_header +[[Return to contents]](#Contents) + +## set_value +[[Return to contents]](#Contents) + +## get_value +[[Return to contents]](#Contents) + +## handle_static +[[Return to contents]](#Contents) + +## host_handle_static +[[Return to contents]](#Contents) + +## mount_static_folder_at +[[Return to contents]](#Contents) + +## host_mount_static_folder_at +[[Return to contents]](#Contents) + +## serve_static +[[Return to contents]](#Contents) + +## host_serve_static +[[Return to contents]](#Contents) + +## user_agent +[[Return to contents]](#Contents) + +## ip +[[Return to contents]](#Contents) + +## error +[[Return to contents]](#Contents) + +## Controller +[[Return to contents]](#Contents) + +## ControllerPath +[[Return to contents]](#Contents) + +## PoolParams +[[Return to contents]](#Contents) + +## RedirectParams +[[Return to contents]](#Contents) + +## Result +[[Return to contents]](#Contents) + +## RunParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/vweb.sse.md b/vdocs/vweb.sse.md new file mode 100644 index 00000000..20e45b14 --- /dev/null +++ b/vdocs/vweb.sse.md @@ -0,0 +1,26 @@ +# module vweb.sse + + +## Contents +- [new_connection](#new_connection) +- [SSEConnection](#SSEConnection) + - [start](#start) + - [send_message](#send_message) +- [SSEMessage](#SSEMessage) + +## new_connection +[[Return to contents]](#Contents) + +## SSEConnection +[[Return to contents]](#Contents) + +## start +[[Return to contents]](#Contents) + +## send_message +[[Return to contents]](#Contents) + +## SSEMessage +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/wasm.md b/vdocs/wasm.md new file mode 100644 index 00000000..f62ebdca --- /dev/null +++ b/vdocs/wasm.md @@ -0,0 +1,506 @@ +# module wasm + + +## Contents +- [constexpr_ref_null](#constexpr_ref_null) +- [constexpr_value](#constexpr_value) +- [constexpr_value_zero](#constexpr_value_zero) +- [DataSegmentIndex](#DataSegmentIndex) +- [GlobalImportIndex](#GlobalImportIndex) +- [GlobalIndex](#GlobalIndex) +- [LabelIndex](#LabelIndex) +- [LocalIndex](#LocalIndex) +- [PatchPos](#PatchPos) +- [NumType](#NumType) +- [RefType](#RefType) +- [ValType](#ValType) +- [ConstExpression](#ConstExpression) + - [i32_const](#i32_const) + - [i64_const](#i64_const) + - [f32_const](#f32_const) + - [f64_const](#f64_const) + - [add](#add) + - [sub](#sub) + - [mul](#mul) + - [global_get](#global_get) + - [ref_null](#ref_null) + - [ref_func](#ref_func) + - [ref_func_import](#ref_func_import) +- [FuncType](#FuncType) +- [Function](#Function) + - [abs](#abs) + - [add](#add) + - [b_and](#b_and) + - [b_or](#b_or) + - [b_shl](#b_shl) + - [b_shr](#b_shr) + - [b_xor](#b_xor) + - [c_block](#c_block) + - [c_br](#c_br) + - [c_br_if](#c_br_if) + - [c_else](#c_else) + - [c_end](#c_end) + - [c_if](#c_if) + - [c_loop](#c_loop) + - [c_return](#c_return) + - [c_select](#c_select) + - [call](#call) + - [call_import](#call_import) + - [cast](#cast) + - [cast_trapping](#cast_trapping) + - [ceil](#ceil) + - [clz](#clz) + - [copysign](#copysign) + - [ctz](#ctz) + - [data_drop](#data_drop) + - [div](#div) + - [drop](#drop) + - [eq](#eq) + - [eqz](#eqz) + - [export_name](#export_name) + - [f32_const](#f32_const) + - [f64_const](#f64_const) + - [floor](#floor) + - [ge](#ge) + - [global_get](#global_get) + - [global_set](#global_set) + - [gt](#gt) + - [i32_const](#i32_const) + - [i64_const](#i64_const) + - [le](#le) + - [load](#load) + - [load16](#load16) + - [load32_i64](#load32_i64) + - [load8](#load8) + - [local_get](#local_get) + - [local_set](#local_set) + - [local_tee](#local_tee) + - [lt](#lt) + - [max](#max) + - [memory_copy](#memory_copy) + - [memory_fill](#memory_fill) + - [memory_grow](#memory_grow) + - [memory_init](#memory_init) + - [memory_size](#memory_size) + - [min](#min) + - [mul](#mul) + - [ne](#ne) + - [nearest](#nearest) + - [neg](#neg) + - [new_local](#new_local) + - [new_local_named](#new_local_named) + - [nop](#nop) + - [patch](#patch) + - [patch_pos](#patch_pos) + - [popcnt](#popcnt) + - [ref_func](#ref_func) + - [ref_func_import](#ref_func_import) + - [ref_is_null](#ref_is_null) + - [ref_null](#ref_null) + - [reinterpret](#reinterpret) + - [rem](#rem) + - [rotl](#rotl) + - [rotr](#rotr) + - [sign_extend16](#sign_extend16) + - [sign_extend32](#sign_extend32) + - [sign_extend8](#sign_extend8) + - [sqrt](#sqrt) + - [store](#store) + - [store16](#store16) + - [store32_i64](#store32_i64) + - [store8](#store8) + - [sub](#sub) + - [trunc](#trunc) + - [unreachable](#unreachable) +- [Module](#Module) + - [assign_global_init](#assign_global_init) + - [assign_memory](#assign_memory) + - [assign_start](#assign_start) + - [commit](#commit) + - [compile](#compile) + - [enable_debug](#enable_debug) + - [new_data_segment](#new_data_segment) + - [new_debug_function](#new_debug_function) + - [new_function](#new_function) + - [new_function_import](#new_function_import) + - [new_function_import_debug](#new_function_import_debug) + - [new_global](#new_global) + - [new_global_import](#new_global_import) + - [new_passive_data_segment](#new_passive_data_segment) + +## constexpr_ref_null +[[Return to contents]](#Contents) + +## constexpr_value +[[Return to contents]](#Contents) + +## constexpr_value_zero +[[Return to contents]](#Contents) + +## DataSegmentIndex +[[Return to contents]](#Contents) + +## GlobalImportIndex +[[Return to contents]](#Contents) + +## GlobalIndex +[[Return to contents]](#Contents) + +## LabelIndex +[[Return to contents]](#Contents) + +## LocalIndex +[[Return to contents]](#Contents) + +## PatchPos +[[Return to contents]](#Contents) + +## NumType +[[Return to contents]](#Contents) + +## RefType +[[Return to contents]](#Contents) + +## ValType +[[Return to contents]](#Contents) + +## ConstExpression +[[Return to contents]](#Contents) + +## i32_const +[[Return to contents]](#Contents) + +## i64_const +[[Return to contents]](#Contents) + +## f32_const +[[Return to contents]](#Contents) + +## f64_const +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## global_get +[[Return to contents]](#Contents) + +## ref_null +[[Return to contents]](#Contents) + +## ref_func +[[Return to contents]](#Contents) + +## ref_func_import +[[Return to contents]](#Contents) + +## FuncType +[[Return to contents]](#Contents) + +## Function +[[Return to contents]](#Contents) + +## abs +[[Return to contents]](#Contents) + +## add +[[Return to contents]](#Contents) + +## b_and +[[Return to contents]](#Contents) + +## b_or +[[Return to contents]](#Contents) + +## b_shl +[[Return to contents]](#Contents) + +## b_shr +[[Return to contents]](#Contents) + +## b_xor +[[Return to contents]](#Contents) + +## c_block +[[Return to contents]](#Contents) + +## c_br +[[Return to contents]](#Contents) + +## c_br_if +[[Return to contents]](#Contents) + +## c_else +[[Return to contents]](#Contents) + +## c_end +[[Return to contents]](#Contents) + +## c_if +[[Return to contents]](#Contents) + +## c_loop +[[Return to contents]](#Contents) + +## c_return +[[Return to contents]](#Contents) + +## c_select +[[Return to contents]](#Contents) + +## call +[[Return to contents]](#Contents) + +## call_import +[[Return to contents]](#Contents) + +## cast +[[Return to contents]](#Contents) + +## cast_trapping +[[Return to contents]](#Contents) + +## ceil +[[Return to contents]](#Contents) + +## clz +[[Return to contents]](#Contents) + +## copysign +[[Return to contents]](#Contents) + +## ctz +[[Return to contents]](#Contents) + +## data_drop +[[Return to contents]](#Contents) + +## div +[[Return to contents]](#Contents) + +## drop +[[Return to contents]](#Contents) + +## eq +[[Return to contents]](#Contents) + +## eqz +[[Return to contents]](#Contents) + +## export_name +[[Return to contents]](#Contents) + +## f32_const +[[Return to contents]](#Contents) + +## f64_const +[[Return to contents]](#Contents) + +## floor +[[Return to contents]](#Contents) + +## ge +[[Return to contents]](#Contents) + +## global_get +[[Return to contents]](#Contents) + +## global_set +[[Return to contents]](#Contents) + +## gt +[[Return to contents]](#Contents) + +## i32_const +[[Return to contents]](#Contents) + +## i64_const +[[Return to contents]](#Contents) + +## le +[[Return to contents]](#Contents) + +## load +[[Return to contents]](#Contents) + +## load16 +[[Return to contents]](#Contents) + +## load32_i64 +[[Return to contents]](#Contents) + +## load8 +[[Return to contents]](#Contents) + +## local_get +[[Return to contents]](#Contents) + +## local_set +[[Return to contents]](#Contents) + +## local_tee +[[Return to contents]](#Contents) + +## lt +[[Return to contents]](#Contents) + +## max +[[Return to contents]](#Contents) + +## memory_copy +[[Return to contents]](#Contents) + +## memory_fill +[[Return to contents]](#Contents) + +## memory_grow +[[Return to contents]](#Contents) + +## memory_init +[[Return to contents]](#Contents) + +## memory_size +[[Return to contents]](#Contents) + +## min +[[Return to contents]](#Contents) + +## mul +[[Return to contents]](#Contents) + +## ne +[[Return to contents]](#Contents) + +## nearest +[[Return to contents]](#Contents) + +## neg +[[Return to contents]](#Contents) + +## new_local +[[Return to contents]](#Contents) + +## new_local_named +[[Return to contents]](#Contents) + +## nop +[[Return to contents]](#Contents) + +## patch +[[Return to contents]](#Contents) + +## patch_pos +[[Return to contents]](#Contents) + +## popcnt +[[Return to contents]](#Contents) + +## ref_func +[[Return to contents]](#Contents) + +## ref_func_import +[[Return to contents]](#Contents) + +## ref_is_null +[[Return to contents]](#Contents) + +## ref_null +[[Return to contents]](#Contents) + +## reinterpret +[[Return to contents]](#Contents) + +## rem +[[Return to contents]](#Contents) + +## rotl +[[Return to contents]](#Contents) + +## rotr +[[Return to contents]](#Contents) + +## sign_extend16 +[[Return to contents]](#Contents) + +## sign_extend32 +[[Return to contents]](#Contents) + +## sign_extend8 +[[Return to contents]](#Contents) + +## sqrt +[[Return to contents]](#Contents) + +## store +[[Return to contents]](#Contents) + +## store16 +[[Return to contents]](#Contents) + +## store32_i64 +[[Return to contents]](#Contents) + +## store8 +[[Return to contents]](#Contents) + +## sub +[[Return to contents]](#Contents) + +## trunc +[[Return to contents]](#Contents) + +## unreachable +[[Return to contents]](#Contents) + +## Module +[[Return to contents]](#Contents) + +## assign_global_init +[[Return to contents]](#Contents) + +## assign_memory +[[Return to contents]](#Contents) + +## assign_start +[[Return to contents]](#Contents) + +## commit +[[Return to contents]](#Contents) + +## compile +[[Return to contents]](#Contents) + +## enable_debug +[[Return to contents]](#Contents) + +## new_data_segment +[[Return to contents]](#Contents) + +## new_debug_function +[[Return to contents]](#Contents) + +## new_function +[[Return to contents]](#Contents) + +## new_function_import +[[Return to contents]](#Contents) + +## new_function_import_debug +[[Return to contents]](#Contents) + +## new_global +[[Return to contents]](#Contents) + +## new_global_import +[[Return to contents]](#Contents) + +## new_passive_data_segment +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.benchmark.md b/vdocs/x.benchmark.md new file mode 100644 index 00000000..9cbb7777 --- /dev/null +++ b/vdocs/x.benchmark.md @@ -0,0 +1,22 @@ +# module x.benchmark + + +## Contents +- [setup](#setup) +- [Benchmark](#Benchmark) + - [run](#run) +- [BenchmarkDefaults](#BenchmarkDefaults) + +## setup +[[Return to contents]](#Contents) + +## Benchmark +[[Return to contents]](#Contents) + +## run +[[Return to contents]](#Contents) + +## BenchmarkDefaults +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.crypto.chacha20.md b/vdocs/x.crypto.chacha20.md new file mode 100644 index 00000000..3343a869 --- /dev/null +++ b/vdocs/x.crypto.chacha20.md @@ -0,0 +1,50 @@ +# module x.crypto.chacha20 + + +## Contents +- [Constants](#Constants) +- [decrypt](#decrypt) +- [encrypt](#encrypt) +- [new_cipher](#new_cipher) +- [Cipher](#Cipher) + - [xor_key_stream](#xor_key_stream) + - [free](#free) + - [reset](#reset) + - [set_counter](#set_counter) + - [rekey](#rekey) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## decrypt +[[Return to contents]](#Contents) + +## encrypt +[[Return to contents]](#Contents) + +## new_cipher +[[Return to contents]](#Contents) + +## Cipher +[[Return to contents]](#Contents) + +## xor_key_stream +[[Return to contents]](#Contents) + +## free +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## set_counter +[[Return to contents]](#Contents) + +## rekey +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.crypto.chacha20poly1305.md b/vdocs/x.crypto.chacha20poly1305.md new file mode 100644 index 00000000..d74ca85f --- /dev/null +++ b/vdocs/x.crypto.chacha20poly1305.md @@ -0,0 +1,50 @@ +# module x.crypto.chacha20poly1305 + + +## Contents +- [Constants](#Constants) +- [decrypt](#decrypt) +- [encrypt](#encrypt) +- [new](#new) +- [AEAD](#AEAD) +- [Chacha20Poly1305](#Chacha20Poly1305) + - [nonce_size](#nonce_size) + - [overhead](#overhead) + - [encrypt](#encrypt) + - [decrypt](#decrypt) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## decrypt +[[Return to contents]](#Contents) + +## encrypt +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## AEAD +[[Return to contents]](#Contents) + +## Chacha20Poly1305 +## nonce_size +[[Return to contents]](#Contents) + +## overhead +[[Return to contents]](#Contents) + +## encrypt +[[Return to contents]](#Contents) + +## decrypt +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.crypto.poly1305.md b/vdocs/x.crypto.poly1305.md new file mode 100644 index 00000000..59810486 --- /dev/null +++ b/vdocs/x.crypto.poly1305.md @@ -0,0 +1,36 @@ +# module x.crypto.poly1305 + + +## Contents +- [create_tag](#create_tag) +- [new](#new) +- [verify_tag](#verify_tag) +- [Poly1305](#Poly1305) + - [update](#update) + - [verify](#verify) + - [finish](#finish) + - [reinit](#reinit) + +## create_tag +[[Return to contents]](#Contents) + +## new +[[Return to contents]](#Contents) + +## verify_tag +[[Return to contents]](#Contents) + +## Poly1305 +## update +[[Return to contents]](#Contents) + +## verify +[[Return to contents]](#Contents) + +## finish +[[Return to contents]](#Contents) + +## reinit +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.crypto.sm4.md b/vdocs/x.crypto.sm4.md new file mode 100644 index 00000000..6656eaf9 --- /dev/null +++ b/vdocs/x.crypto.sm4.md @@ -0,0 +1,26 @@ +# module x.crypto.sm4 + + +## Contents +- [new_cipher](#new_cipher) +- [Mode](#Mode) +- [SM4Cipher](#SM4Cipher) + - [crypt_ecb](#crypt_ecb) + - [crypt_cbc](#crypt_cbc) + +## new_cipher +[[Return to contents]](#Contents) + +## Mode +[[Return to contents]](#Contents) + +## SM4Cipher +[[Return to contents]](#Contents) + +## crypt_ecb +[[Return to contents]](#Contents) + +## crypt_cbc +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.encoding.asn1.md b/vdocs/x.encoding.asn1.md new file mode 100644 index 00000000..506871e7 --- /dev/null +++ b/vdocs/x.encoding.asn1.md @@ -0,0 +1,902 @@ +# module x.encoding.asn1 + + +## Contents +- [Constants](#Constants) +- [decode](#decode) +- [decode_with_field_options](#decode_with_field_options) +- [decode_with_options](#decode_with_options) +- [encode](#encode) +- [encode_with_field_options](#encode_with_field_options) +- [encode_with_options](#encode_with_options) +- [encoded_len](#encoded_len) +- [make_payload](#make_payload) +- [new_key_default](#new_key_default) +- [AnyDefinedBy.new](#AnyDefinedBy.new) +- [ApplicationElement.from_element](#ApplicationElement.from_element) +- [ApplicationElement.new](#ApplicationElement.new) +- [BitString.from_binary_string](#BitString.from_binary_string) +- [BitString.new](#BitString.new) +- [Boolean.new](#Boolean.new) +- [Boolean.parse](#Boolean.parse) +- [Choice.new](#Choice.new) +- [ContextElement.explicit_context](#ContextElement.explicit_context) +- [ContextElement.from_element](#ContextElement.from_element) +- [ContextElement.implicit_context](#ContextElement.implicit_context) +- [ContextElement.new](#ContextElement.new) +- [Element.from_object](#Element.from_object) +- [ElementList.from_bytes](#ElementList.from_bytes) +- [Enumerated.new](#Enumerated.new) +- [FieldOptions.from_attrs](#FieldOptions.from_attrs) +- [FieldOptions.from_string](#FieldOptions.from_string) +- [GeneralString.new](#GeneralString.new) +- [GeneralizedTime.from_time](#GeneralizedTime.from_time) +- [GeneralizedTime.new](#GeneralizedTime.new) +- [IA5String.new](#IA5String.new) +- [Integer.from_bigint](#Integer.from_bigint) +- [Integer.from_hex](#Integer.from_hex) +- [Integer.from_i64](#Integer.from_i64) +- [Integer.from_int](#Integer.from_int) +- [Integer.from_string](#Integer.from_string) +- [Length.from_bytes](#Length.from_bytes) +- [Length.new](#Length.new) +- [NumericString.new](#NumericString.new) +- [ObjectIdentifier.from_ints](#ObjectIdentifier.from_ints) +- [ObjectIdentifier.new](#ObjectIdentifier.new) +- [OctetString.from_hexstring](#OctetString.from_hexstring) +- [OctetString.new](#OctetString.new) +- [Optional.new](#Optional.new) +- [Parser.new](#Parser.new) +- [PrintableString.new](#PrintableString.new) +- [PrivateELement.from_element](#PrivateELement.from_element) +- [PrivateELement.new](#PrivateELement.new) +- [RawElement.from_element](#RawElement.from_element) +- [RawElement.new](#RawElement.new) +- [Sequence.from_list](#Sequence.from_list) +- [Sequence.new](#Sequence.new) +- [SequenceOf.from_list](#SequenceOf.from_list) +- [SequenceOf.new](#SequenceOf.new) +- [Set.from_list](#Set.from_list) +- [Set.new](#Set.new) +- [SetOf.from_list](#SetOf.from_list) +- [SetOf.new](#SetOf.new) +- [Tag.from_bytes](#Tag.from_bytes) +- [Tag.new](#Tag.new) +- [UtcTime.from_time](#UtcTime.from_time) +- [UtcTime.new](#UtcTime.new) +- [Utf8String.from_bytes](#Utf8String.from_bytes) +- [Utf8String.new](#Utf8String.new) +- [VisibleString.new](#VisibleString.new) +- [Element](#Element) + - [encoded_len](#encoded_len) + - [equal](#equal) + - [into_object](#into_object) + - [length](#length) + - [set_default_value](#set_default_value) + - [unwrap_with_field_options](#unwrap_with_field_options) + - [unwrap_with_options](#unwrap_with_options) +- [ElementList](#ElementList) + - [payload](#payload) + - [encoded_len](#encoded_len) +- [KeyDefault](#KeyDefault) +- [Length](#Length) + - [encode](#encode) +- [SequenceOf[T]](#SequenceOf[T]) + - [tag](#tag) + - [payload](#payload) + - [fields](#fields) +- [SetOf[T]](#SetOf[T]) + - [tag](#tag) + - [fields](#fields) + - [payload](#payload) + - [add_element](#add_element) +- [EncodingRule](#EncodingRule) +- [TagClass](#TagClass) +- [TagType](#TagType) +- [TaggedMode](#TaggedMode) +- [AnyDefinedBy](#AnyDefinedBy) + - [tag](#tag) + - [payload](#payload) +- [ApplicationElement](#ApplicationElement) + - [tag](#tag) + - [payload](#payload) +- [BitString](#BitString) + - [data](#data) + - [pad](#pad) + - [tag](#tag) + - [payload](#payload) +- [Boolean](#Boolean) + - [tag](#tag) + - [payload](#payload) + - [value](#value) +- [Choice](#Choice) + - [set_size](#set_size) + - [choose](#choose) + - [tag](#tag) + - [payload](#payload) +- [ContextElement](#ContextElement) + - [tag](#tag) + - [payload](#payload) +- [Enumerated](#Enumerated) + - [tag](#tag) + - [payload](#payload) +- [FieldOptions](#FieldOptions) + - [install_default](#install_default) +- [GeneralString](#GeneralString) + - [tag](#tag) + - [payload](#payload) +- [GeneralizedTime](#GeneralizedTime) + - [into_utctime](#into_utctime) + - [tag](#tag) + - [payload](#payload) +- [IA5String](#IA5String) + - [tag](#tag) + - [payload](#payload) +- [Integer](#Integer) + - [hex](#hex) + - [tag](#tag) + - [payload](#payload) + - [equal](#equal) + - [as_bigint](#as_bigint) + - [as_i64](#as_i64) +- [Null](#Null) + - [tag](#tag) + - [payload](#payload) +- [NumericString](#NumericString) + - [tag](#tag) + - [payload](#payload) +- [ObjectIdentifier](#ObjectIdentifier) + - [value](#value) + - [tag](#tag) + - [payload](#payload) + - [equal](#equal) +- [OctetString](#OctetString) + - [tag](#tag) + - [payload](#payload) +- [Optional](#Optional) + - [set_present_bit](#set_present_bit) + - [tag](#tag) + - [payload](#payload) + - [encode](#encode) + - [into_element](#into_element) + - [into_object](#into_object) +- [Parser](#Parser) + - [reset](#reset) + - [peek_tag](#peek_tag) + - [read_tag](#read_tag) + - [read_length](#read_length) + - [read_bytes](#read_bytes) + - [read_tlv](#read_tlv) + - [finish](#finish) + - [is_empty](#is_empty) +- [PrintableString](#PrintableString) + - [tag](#tag) + - [payload](#payload) +- [PrivateELement](#PrivateELement) + - [tag](#tag) + - [payload](#payload) +- [RawElement](#RawElement) + - [tag](#tag) + - [payload](#payload) + - [set_mode](#set_mode) + - [set_inner_tag](#set_inner_tag) + - [inner_tag](#inner_tag) + - [inner_element](#inner_element) +- [Sequence](#Sequence) + - [tag](#tag) + - [payload](#payload) + - [encoded_len](#encoded_len) + - [fields](#fields) + - [set_size](#set_size) + - [add_element](#add_element) + - [is_sequence_of](#is_sequence_of) + - [into_sequence_of](#into_sequence_of) +- [SequenceOf](#SequenceOf) +- [Set](#Set) + - [tag](#tag) + - [payload](#payload) + - [fields](#fields) + - [add_element](#add_element) + - [set_size](#set_size) +- [SetOf](#SetOf) +- [Tag](#Tag) + - [tag_class](#tag_class) + - [is_constructed](#is_constructed) + - [tag_number](#tag_number) + - [encode](#encode) + - [equal](#equal) + - [tag_size](#tag_size) + - [universal_tag_type](#universal_tag_type) +- [UtcTime](#UtcTime) + - [tag](#tag) + - [payload](#payload) + - [into_utctime](#into_utctime) +- [Utf8String](#Utf8String) + - [tag](#tag) + - [payload](#payload) +- [VisibleString](#VisibleString) + - [tag](#tag) + - [payload](#payload) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +## decode_with_field_options +[[Return to contents]](#Contents) + +## decode_with_options +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## encode_with_field_options +[[Return to contents]](#Contents) + +## encode_with_options +[[Return to contents]](#Contents) + +## encoded_len +[[Return to contents]](#Contents) + +## make_payload +[[Return to contents]](#Contents) + +## new_key_default +[[Return to contents]](#Contents) + +## AnyDefinedBy.new +[[Return to contents]](#Contents) + +## ApplicationElement.from_element +[[Return to contents]](#Contents) + +## ApplicationElement.new +[[Return to contents]](#Contents) + +## BitString.from_binary_string +Example +```v + +import x.encoding.asn1 + +bs := asn1.BitString.from_binary_string('011010001')! + assert (bs.pad == 7 && bs.data == [u8(0x68), 0x80]) == true + +``` + +[[Return to contents]](#Contents) + +## BitString.new +[[Return to contents]](#Contents) + +## Boolean.new +[[Return to contents]](#Contents) + +## Boolean.parse +[[Return to contents]](#Contents) + +## Choice.new +[[Return to contents]](#Contents) + +## ContextElement.explicit_context +[[Return to contents]](#Contents) + +## ContextElement.from_element +[[Return to contents]](#Contents) + +## ContextElement.implicit_context +[[Return to contents]](#Contents) + +## ContextElement.new +[[Return to contents]](#Contents) + +## Element.from_object +[[Return to contents]](#Contents) + +## ElementList.from_bytes +[[Return to contents]](#Contents) + +## Enumerated.new +[[Return to contents]](#Contents) + +## FieldOptions.from_attrs +[[Return to contents]](#Contents) + +## FieldOptions.from_string +[[Return to contents]](#Contents) + +## GeneralString.new +[[Return to contents]](#Contents) + +## GeneralizedTime.from_time +[[Return to contents]](#Contents) + +## GeneralizedTime.new +[[Return to contents]](#Contents) + +## IA5String.new +[[Return to contents]](#Contents) + +## Integer.from_bigint +[[Return to contents]](#Contents) + +## Integer.from_hex +[[Return to contents]](#Contents) + +## Integer.from_i64 +[[Return to contents]](#Contents) + +## Integer.from_int +[[Return to contents]](#Contents) + +## Integer.from_string +[[Return to contents]](#Contents) + +## Length.from_bytes +[[Return to contents]](#Contents) + +## Length.new +[[Return to contents]](#Contents) + +## NumericString.new +[[Return to contents]](#Contents) + +## ObjectIdentifier.from_ints +[[Return to contents]](#Contents) + +## ObjectIdentifier.new +[[Return to contents]](#Contents) + +## OctetString.from_hexstring +[[Return to contents]](#Contents) + +## OctetString.new +[[Return to contents]](#Contents) + +## Optional.new +[[Return to contents]](#Contents) + +## Parser.new +[[Return to contents]](#Contents) + +## PrintableString.new +[[Return to contents]](#Contents) + +## PrivateELement.from_element +[[Return to contents]](#Contents) + +## PrivateELement.new +[[Return to contents]](#Contents) + +## RawElement.from_element +[[Return to contents]](#Contents) + +## RawElement.new +[[Return to contents]](#Contents) + +## Sequence.from_list +[[Return to contents]](#Contents) + +## Sequence.new +[[Return to contents]](#Contents) + +## SequenceOf.from_list +[[Return to contents]](#Contents) + +## SequenceOf.new +[[Return to contents]](#Contents) + +## Set.from_list +[[Return to contents]](#Contents) + +## Set.new +[[Return to contents]](#Contents) + +## SetOf.from_list +[[Return to contents]](#Contents) + +## SetOf.new +[[Return to contents]](#Contents) + +## Tag.from_bytes +[[Return to contents]](#Contents) + +## Tag.new +[[Return to contents]](#Contents) + +## UtcTime.from_time +[[Return to contents]](#Contents) + +## UtcTime.new +[[Return to contents]](#Contents) + +## Utf8String.from_bytes +[[Return to contents]](#Contents) + +## Utf8String.new +[[Return to contents]](#Contents) + +## VisibleString.new +[[Return to contents]](#Contents) + +## Element +[[Return to contents]](#Contents) + +## encoded_len +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## into_object +[[Return to contents]](#Contents) + +## length +[[Return to contents]](#Contents) + +## set_default_value +[[Return to contents]](#Contents) + +## unwrap_with_field_options +[[Return to contents]](#Contents) + +## unwrap_with_options +[[Return to contents]](#Contents) + +## ElementList +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## encoded_len +[[Return to contents]](#Contents) + +## KeyDefault +[[Return to contents]](#Contents) + +## Length +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## SequenceOf[T] +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## fields +[[Return to contents]](#Contents) + +## SetOf[T] +## tag +[[Return to contents]](#Contents) + +## fields +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## add_element +[[Return to contents]](#Contents) + +## EncodingRule +[[Return to contents]](#Contents) + +## TagClass +[[Return to contents]](#Contents) + +## TagType +[[Return to contents]](#Contents) + +## TaggedMode +[[Return to contents]](#Contents) + +## AnyDefinedBy +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## ApplicationElement +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## BitString +[[Return to contents]](#Contents) + +## data +[[Return to contents]](#Contents) + +## pad +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## Boolean +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## Choice +[[Return to contents]](#Contents) + +## set_size +[[Return to contents]](#Contents) + +## choose +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## ContextElement +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## Enumerated +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## FieldOptions +[[Return to contents]](#Contents) + +## install_default +[[Return to contents]](#Contents) + +## GeneralString +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## GeneralizedTime +[[Return to contents]](#Contents) + +## into_utctime +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## IA5String +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## Integer +[[Return to contents]](#Contents) + +## hex +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## as_bigint +[[Return to contents]](#Contents) + +## as_i64 +[[Return to contents]](#Contents) + +## Null +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## NumericString +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## ObjectIdentifier +[[Return to contents]](#Contents) + +## value +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## OctetString +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## Optional +[[Return to contents]](#Contents) + +## set_present_bit +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## into_element +[[Return to contents]](#Contents) + +## into_object +[[Return to contents]](#Contents) + +## Parser +[[Return to contents]](#Contents) + +## reset +[[Return to contents]](#Contents) + +## peek_tag +[[Return to contents]](#Contents) + +## read_tag +[[Return to contents]](#Contents) + +## read_length +[[Return to contents]](#Contents) + +## read_bytes +[[Return to contents]](#Contents) + +## read_tlv +[[Return to contents]](#Contents) + +## finish +[[Return to contents]](#Contents) + +## is_empty +[[Return to contents]](#Contents) + +## PrintableString +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## PrivateELement +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## RawElement +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## set_mode +[[Return to contents]](#Contents) + +## set_inner_tag +[[Return to contents]](#Contents) + +## inner_tag +[[Return to contents]](#Contents) + +## inner_element +[[Return to contents]](#Contents) + +## Sequence +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## encoded_len +[[Return to contents]](#Contents) + +## fields +[[Return to contents]](#Contents) + +## set_size +[[Return to contents]](#Contents) + +## add_element +[[Return to contents]](#Contents) + +## is_sequence_of +[[Return to contents]](#Contents) + +## into_sequence_of +[[Return to contents]](#Contents) + +## SequenceOf +[[Return to contents]](#Contents) + +## Set +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## fields +[[Return to contents]](#Contents) + +## add_element +[[Return to contents]](#Contents) + +## set_size +[[Return to contents]](#Contents) + +## SetOf +[[Return to contents]](#Contents) + +## Tag +[[Return to contents]](#Contents) + +## tag_class +[[Return to contents]](#Contents) + +## is_constructed +[[Return to contents]](#Contents) + +## tag_number +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## equal +[[Return to contents]](#Contents) + +## tag_size +[[Return to contents]](#Contents) + +## universal_tag_type +[[Return to contents]](#Contents) + +## UtcTime +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## into_utctime +[[Return to contents]](#Contents) + +## Utf8String +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +## VisibleString +[[Return to contents]](#Contents) + +## tag +[[Return to contents]](#Contents) + +## payload +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.json2.decoder2.md b/vdocs/x.json2.decoder2.md new file mode 100644 index 00000000..6d55b53c --- /dev/null +++ b/vdocs/x.json2.decoder2.md @@ -0,0 +1,26 @@ +# module x.json2.decoder2 + + +## Contents +- [decode](#decode) +- [decode_array](#decode_array) +- [new_decoder](#new_decoder) +- [string_buffer_to_generic_number](#string_buffer_to_generic_number) +- [ValueKind](#ValueKind) + +## decode +[[Return to contents]](#Contents) + +## decode_array +[[Return to contents]](#Contents) + +## new_decoder +[[Return to contents]](#Contents) + +## string_buffer_to_generic_number +[[Return to contents]](#Contents) + +## ValueKind +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:57 diff --git a/vdocs/x.json2.md b/vdocs/x.json2.md new file mode 100644 index 00000000..f16413a9 --- /dev/null +++ b/vdocs/x.json2.md @@ -0,0 +1,194 @@ +# module x.json2 + + +## Contents +- [Constants](#Constants) +- [decode](#decode) +- [decode_array](#decode_array) +- [encode](#encode) +- [encode_pretty](#encode_pretty) +- [fast_raw_decode](#fast_raw_decode) +- [map_from](#map_from) +- [raw_decode](#raw_decode) +- [Decodable](#Decodable) +- [Encodable](#Encodable) +- [Any](#Any) + - [arr](#arr) + - [as_map](#as_map) + - [bool](#bool) + - [f32](#f32) + - [f64](#f64) + - [i16](#i16) + - [i32](#i32) + - [i64](#i64) + - [i8](#i8) + - [int](#int) + - [json_str](#json_str) + - [prettify_json_str](#prettify_json_str) + - [str](#str) + - [to_time](#to_time) + - [u64](#u64) + - [u8](#u8) +- [Parser](#Parser) + - [decode](#decode) +- [[]Any](#[]Any) + - [str](#str) +- [map[string]Any](#map[string]Any) + - [str](#str) +- [ValueKind](#ValueKind) + - [str](#str) +- [DecodeError](#DecodeError) + - [code](#code) + - [msg](#msg) +- [Encoder](#Encoder) + - [encode_value](#encode_value) +- [InvalidTokenError](#InvalidTokenError) + - [code](#code) + - [msg](#msg) +- [Null](#Null) +- [Token](#Token) + - [full_col](#full_col) +- [UnknownTokenError](#UnknownTokenError) + - [code](#code) + - [msg](#msg) + +## Constants +[[Return to contents]](#Contents) + +## decode +[[Return to contents]](#Contents) + +## decode_array +[[Return to contents]](#Contents) + +## encode +[[Return to contents]](#Contents) + +## encode_pretty +[[Return to contents]](#Contents) + +## fast_raw_decode +[[Return to contents]](#Contents) + +## map_from +[[Return to contents]](#Contents) + +## raw_decode +[[Return to contents]](#Contents) + +## Decodable +[[Return to contents]](#Contents) + +## Encodable +[[Return to contents]](#Contents) + +## Any +## arr +[[Return to contents]](#Contents) + +## as_map +[[Return to contents]](#Contents) + +## bool +[[Return to contents]](#Contents) + +## f32 +[[Return to contents]](#Contents) + +## f64 +[[Return to contents]](#Contents) + +## i16 +[[Return to contents]](#Contents) + +## i32 +[[Return to contents]](#Contents) + +## i64 +[[Return to contents]](#Contents) + +## i8 +[[Return to contents]](#Contents) + +## int +[[Return to contents]](#Contents) + +## json_str +[[Return to contents]](#Contents) + +## prettify_json_str +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## to_time +[[Return to contents]](#Contents) + +## u64 +[[Return to contents]](#Contents) + +## u8 +[[Return to contents]](#Contents) + +## Parser +## decode +[[Return to contents]](#Contents) + +## []Any +## str +[[Return to contents]](#Contents) + +## map[string]Any +## str +[[Return to contents]](#Contents) + +## ValueKind +[[Return to contents]](#Contents) + +## str +[[Return to contents]](#Contents) + +## DecodeError +[[Return to contents]](#Contents) + +## code +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## Encoder +[[Return to contents]](#Contents) + +## encode_value +[[Return to contents]](#Contents) + +## InvalidTokenError +[[Return to contents]](#Contents) + +## code +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +## Null +[[Return to contents]](#Contents) + +## Token +[[Return to contents]](#Contents) + +## full_col +[[Return to contents]](#Contents) + +## UnknownTokenError +[[Return to contents]](#Contents) + +## code +[[Return to contents]](#Contents) + +## msg +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:57 diff --git a/vdocs/x.json2.strict.md b/vdocs/x.json2.strict.md new file mode 100644 index 00000000..803d945a --- /dev/null +++ b/vdocs/x.json2.strict.md @@ -0,0 +1,26 @@ +# module x.json2.strict + + +## Contents +- [get_keys_from_json](#get_keys_from_json) +- [strict_check](#strict_check) +- [KeyType](#KeyType) +- [KeyStruct](#KeyStruct) +- [StructCheckResult](#StructCheckResult) + +## get_keys_from_json +[[Return to contents]](#Contents) + +## strict_check +[[Return to contents]](#Contents) + +## KeyType +[[Return to contents]](#Contents) + +## KeyStruct +[[Return to contents]](#Contents) + +## StructCheckResult +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:57 diff --git a/vdocs/x.md b/vdocs/x.md new file mode 100644 index 00000000..62c68ed9 --- /dev/null +++ b/vdocs/x.md @@ -0,0 +1,10 @@ +# module x + + +## Contents +- [Constants](#Constants) + +## Constants +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:56 diff --git a/vdocs/x.sessions.md b/vdocs/x.sessions.md new file mode 100644 index 00000000..55d61fa0 --- /dev/null +++ b/vdocs/x.sessions.md @@ -0,0 +1,152 @@ +# module x.sessions + + +## Contents +- [new_session_id](#new_session_id) +- [verify_session_id](#verify_session_id) +- [DBStore.create](#DBStore.create) +- [Store](#Store) + - [all](#all) + - [clear](#clear) +- [DBStore[T]](#DBStore[T]) + - [all](#all) + - [get](#get) + - [destroy](#destroy) + - [clear](#clear) + - [set](#set) +- [MemoryStore[T]](#MemoryStore[T]) + - [all](#all) + - [get](#get) + - [destroy](#destroy) + - [clear](#clear) + - [set](#set) +- [Sessions[T]](#Sessions[T]) + - [set_session_id](#set_session_id) + - [validate_session](#validate_session) + - [get](#get) + - [destroy](#destroy) + - [logout](#logout) + - [save](#save) + - [resave](#resave) + - [get_session_id](#get_session_id) +- [CookieOptions](#CookieOptions) +- [CurrentSession](#CurrentSession) +- [DBStore](#DBStore) +- [DBStoreSessions](#DBStoreSessions) +- [MemoryStore](#MemoryStore) +- [Sessions](#Sessions) + +## new_session_id +[[Return to contents]](#Contents) + +## verify_session_id +[[Return to contents]](#Contents) + +## DBStore.create +[[Return to contents]](#Contents) + +## Store +[[Return to contents]](#Contents) + +## all +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## DBStore[T] +## all +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## MemoryStore[T] +## all +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## set +[[Return to contents]](#Contents) + +## Sessions[T] +## set_session_id +[[Return to contents]](#Contents) + +## validate_session +[[Return to contents]](#Contents) + +## get +[[Return to contents]](#Contents) + +## destroy +[[Return to contents]](#Contents) + +## logout +[[Return to contents]](#Contents) + +## save +[[Return to contents]](#Contents) + +## resave +[[Return to contents]](#Contents) + +## get_session_id +[[Return to contents]](#Contents) + +## CookieOptions +[[Return to contents]](#Contents) + +## CurrentSession +Example +```v + +pub struct Context { + vweb.Context + sessions.CurrentSessions[User] +} + +``` + +[[Return to contents]](#Contents) + +## DBStore +[[Return to contents]](#Contents) + +## DBStoreSessions +[[Return to contents]](#Contents) + +## MemoryStore +[[Return to contents]](#Contents) + +## Sessions +Example +```v + +pub struct App { +pub mut: + sessions &sessions.Sessions[User] +} + +``` + +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:57 diff --git a/vdocs/x.sessions.vweb2_middleware.md b/vdocs/x.sessions.vweb2_middleware.md new file mode 100644 index 00000000..aa5e3a51 --- /dev/null +++ b/vdocs/x.sessions.vweb2_middleware.md @@ -0,0 +1,17 @@ +# module x.sessions.vweb2_middleware + + +## Contents +- [create](#create) + +## create +Example +```v + +app.use(app.sessions.middleware[Context]()) + +``` + +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:57 diff --git a/vdocs/x.templating.dtm.md b/vdocs/x.templating.dtm.md new file mode 100644 index 00000000..c61b1a62 --- /dev/null +++ b/vdocs/x.templating.dtm.md @@ -0,0 +1,46 @@ +# module x.templating.dtm + + +## Contents +- [Constants](#Constants) +- [initialize](#initialize) +- [DtmMultiTypeMap](#DtmMultiTypeMap) +- [CacheStorageMode](#CacheStorageMode) +- [DynamicTemplateManager](#DynamicTemplateManager) + - [expand](#expand) + - [stop_cache_handler](#stop_cache_handler) +- [DynamicTemplateManagerInitialisationParams](#DynamicTemplateManagerInitialisationParams) +- [TemplateCacheParams](#TemplateCacheParams) + +## Constants +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +[[Return to contents]](#Contents) + +## initialize +[[Return to contents]](#Contents) + +## DtmMultiTypeMap +[[Return to contents]](#Contents) + +## CacheStorageMode +[[Return to contents]](#Contents) + +## DynamicTemplateManager +[[Return to contents]](#Contents) + +## expand +[[Return to contents]](#Contents) + +## stop_cache_handler +[[Return to contents]](#Contents) + +## DynamicTemplateManagerInitialisationParams +[[Return to contents]](#Contents) + +## TemplateCacheParams +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:57 diff --git a/vdocs/x.ttf.md b/vdocs/x.ttf.md new file mode 100644 index 00000000..827e4f23 --- /dev/null +++ b/vdocs/x.ttf.md @@ -0,0 +1,206 @@ +# module x.ttf + + +## Contents +- [color_multiply](#color_multiply) +- [color_multiply_alpha](#color_multiply_alpha) +- [Style](#Style) +- [Text_align](#Text_align) +- [BitMap](#BitMap) + - [aline](#aline) + - [box](#box) + - [clear](#clear) + - [clear_filler](#clear_filler) + - [draw_glyph](#draw_glyph) + - [draw_text](#draw_text) + - [draw_text_block](#draw_text_block) + - [exec_filler](#exec_filler) + - [fline](#fline) + - [get_bbox](#get_bbox) + - [get_chars_bbox](#get_chars_bbox) + - [get_justify_space_cw](#get_justify_space_cw) + - [get_raw_bytes](#get_raw_bytes) + - [init_filler](#init_filler) + - [line](#line) + - [plot](#plot) + - [quadratic](#quadratic) + - [save_as_ppm](#save_as_ppm) + - [save_raw_data](#save_raw_data) + - [set_pos](#set_pos) + - [set_rotation](#set_rotation) + - [trf_ch](#trf_ch) + - [trf_txt](#trf_txt) +- [Glyph](#Glyph) +- [Point](#Point) +- [TTF_File](#TTF_File) + - [init](#init) + - [get_horizontal_metrics](#get_horizontal_metrics) + - [glyph_count](#glyph_count) + - [read_glyph_dim](#read_glyph_dim) + - [get_ttf_widths](#get_ttf_widths) + - [read_glyph](#read_glyph) + - [map_code](#map_code) + - [reset_kern](#reset_kern) + - [next_kern](#next_kern) + - [get_info_string](#get_info_string) +- [TTF_render_Sokol](#TTF_render_Sokol) + - [format_texture](#format_texture) + - [create_text](#create_text) + - [create_text_block](#create_text_block) + - [create_texture](#create_texture) + - [destroy_texture](#destroy_texture) + - [update_text_texture](#update_text_texture) + - [draw_text_bmp](#draw_text_bmp) +- [Text_block](#Text_block) + +## color_multiply +[[Return to contents]](#Contents) + +## color_multiply_alpha +[[Return to contents]](#Contents) + +## Style +[[Return to contents]](#Contents) + +## Text_align +[[Return to contents]](#Contents) + +## BitMap +[[Return to contents]](#Contents) + +## aline +[[Return to contents]](#Contents) + +## box +[[Return to contents]](#Contents) + +## clear +[[Return to contents]](#Contents) + +## clear_filler +[[Return to contents]](#Contents) + +## draw_glyph +[[Return to contents]](#Contents) + +## draw_text +[[Return to contents]](#Contents) + +## draw_text_block +[[Return to contents]](#Contents) + +## exec_filler +[[Return to contents]](#Contents) + +## fline +[[Return to contents]](#Contents) + +## get_bbox +[[Return to contents]](#Contents) + +## get_chars_bbox +[[Return to contents]](#Contents) + +## get_justify_space_cw +[[Return to contents]](#Contents) + +## get_raw_bytes +[[Return to contents]](#Contents) + +## init_filler +[[Return to contents]](#Contents) + +## line +[[Return to contents]](#Contents) + +## plot +[[Return to contents]](#Contents) + +## quadratic +[[Return to contents]](#Contents) + +## save_as_ppm +[[Return to contents]](#Contents) + +## save_raw_data +[[Return to contents]](#Contents) + +## set_pos +[[Return to contents]](#Contents) + +## set_rotation +[[Return to contents]](#Contents) + +## trf_ch +[[Return to contents]](#Contents) + +## trf_txt +[[Return to contents]](#Contents) + +## Glyph +[[Return to contents]](#Contents) + +## Point +[[Return to contents]](#Contents) + +## TTF_File +[[Return to contents]](#Contents) + +## init +[[Return to contents]](#Contents) + +## get_horizontal_metrics +[[Return to contents]](#Contents) + +## glyph_count +[[Return to contents]](#Contents) + +## read_glyph_dim +[[Return to contents]](#Contents) + +## get_ttf_widths +[[Return to contents]](#Contents) + +## read_glyph +[[Return to contents]](#Contents) + +## map_code +[[Return to contents]](#Contents) + +## reset_kern +[[Return to contents]](#Contents) + +## next_kern +[[Return to contents]](#Contents) + +## get_info_string +[[Return to contents]](#Contents) + +## TTF_render_Sokol +[[Return to contents]](#Contents) + +## format_texture +[[Return to contents]](#Contents) + +## create_text +[[Return to contents]](#Contents) + +## create_text_block +[[Return to contents]](#Contents) + +## create_texture +[[Return to contents]](#Contents) + +## destroy_texture +[[Return to contents]](#Contents) + +## update_text_texture +[[Return to contents]](#Contents) + +## draw_text_bmp +[[Return to contents]](#Contents) + +## Text_block +[[Return to contents]](#Contents) + +#### Powered by vdoc. Generated on: 7 Feb 2025 12:06:57