ziglang/zig
265
6.0k
Fork
You've already forked zig
786

If add optional function arguments? #30678

Closed
opened 2026年01月04日 16:27:37 +01:00 by aliferne · 7 comments

Hi there, I'm writing the zig code with Version 0.15.1, and when I was writing a function:

fntester(a:i32,b:?i32)i32{b=borelse10;returna+b;}pubfnmain()void{std.debug.print("Result: {d}",.{tester(1)});}

I'm expecting for the result 11, but the compiler returned an error message:

main.zig:9:1: note: function declared here
fn tester(a: i32, b: ?i32) i32 {
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
referenced by:
callMain [inlined]: xxx/zig-x86_64-linux/lib/std/start.zig:627:37
callMainWithArgs [inlined]: xxx/zig-x86_64-linux/lib/std/start.zig:587:20
posixCallMainAndExit: xxx/zig-x86_64-linux/lib/std/start.zig:542:36
2 reference(s) hidden; use '-freference-trace=5' to see all references

I'm wondering if there's a plan to add optional function arguments? If ?type represents type or null, then it's silly for compiler to give such a message, since it's optional.

Or maybe we can add default value to the arguments? Just like:

pub fn tester(a: i32 = 1, b: i32 = 10) i32 {
 // ...
}

Thanks!

Hi there, I'm writing the zig code with Version 0.15.1, and when I was writing a function: ```zig fn tester(a: i32, b: ?i32) i32 { b = b orelse 10; return a + b; } pub fn main() void { std.debug.print("Result: {d}", .{tester(1)}); } ``` I'm expecting for the result 11, but the compiler returned an error message: main.zig:9:1: note: function declared here fn tester(a: i32, b: ?i32) i32 { ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ referenced by: callMain [inlined]: xxx/zig-x86_64-linux/lib/std/start.zig:627:37 callMainWithArgs [inlined]: xxx/zig-x86_64-linux/lib/std/start.zig:587:20 posixCallMainAndExit: xxx/zig-x86_64-linux/lib/std/start.zig:542:36 2 reference(s) hidden; use '-freference-trace=5' to see all references I'm wondering if there's a plan to add optional function arguments? If `?type` represents `type or null`, then it's silly for compiler to give such a message, since it's optional. Or maybe we can add default value to the arguments? Just like: ``` pub fn tester(a: i32 = 1, b: i32 = 10) i32 { // ... } ``` Thanks!
Contributor
Copy link

Considering that zig prefers readability over writability (and thus explicit arguments over implicit/predefined ones), I doubt that feature will be added.

As for your tester function,
a) while the ?i32 type is called optional according to documentation (which imo should maybe be changed), it is more just nullable. It is not optional in the sense that giving it a value isn't required, const a: ?i32; would also fail without giving an explicit value to it.
b) you're also trying to re-assign the argument b to another value, which would also be a compile error, as function arguments are always const. If you want to keep a pattern like you've got there, the common idea is to name the function parameter maybe_b or something similar and then provide the default value with const b = maybe_b orelse DEFAULT_VAL; at the start of the function.

Considering that zig prefers readability over writability (and thus explicit arguments over implicit/predefined ones), I doubt that feature will be added. As for your `tester` function, a) while the `?i32` type is called *optional* according to documentation (which imo should maybe be changed), it is more just *nullable*. It is not optional in the sense that giving it a value isn't required, `const a: ?i32;` would also fail without giving an explicit value to it. b) you're also trying to re-assign the argument `b` to another value, which would also be a compile error, as function arguments are always `const`. If you want to keep a pattern like you've got there, the common idea is to name the function parameter `maybe_b` or something similar and then provide the default value with `const b = maybe_b orelse DEFAULT_VAL;` at the start of the function.

@Rue04 Got that, I just wrote an example to ask if this proposal will be approved.

a) My personal understanding when reading the Optional in the document, is that ?type refers to an optional value, if no value assigned, it should be null, so I guess it can be used in function arguments when I don't want to assign value.

b) I was writing the function in a structure:

constImage=struct{rows:u32=0,cols:u32=0,pixels:[*]Color=&.{},pubfninit(rows:?u32,cols:?u32,pixels:?[*]Color)Image{return{.rows=rowsorelse0,.cols=colsorelse0,.pixels=pixelsorelse&.{},};}pubfnreadFromFile(self:*Image,...,)!void{// ...}};

I was seeking for solutions if I can use the structure by both:

constimage=Image.init(rows,cols,pixels);

and:

varimage=Image.init();image.readFromFile(filename);

Do you have any good advice? I just suppose that a structure shouldn't have two functions for initializing.

@Rue04 Got that, I just wrote an example to ask if this proposal will be approved. a) My personal understanding when reading the Optional in the document, is that `?type` refers to an optional value, if no value assigned, it should be null, so I guess it can be used in function arguments when I don't want to assign value. b) I was writing the function in a structure: ```zig const Image = struct { rows: u32 = 0, cols: u32 = 0, pixels: [*]Color = &.{}, pub fn init(rows: ?u32, cols: ?u32, pixels: ?[*]Color) Image { return { .rows = rows orelse 0, .cols = cols orelse 0, .pixels = pixels orelse &.{}, }; } pub fn readFromFile(self: *Image, ...,) !void { // ... } }; ``` I was seeking for solutions if I can use the structure by both: ```zig const image = Image.init(rows, cols, pixels); ``` and: ```zig var image = Image.init(); image.readFromFile(filename); ``` Do you have any good advice? I just suppose that a structure shouldn't have two functions for initializing.
Contributor
Copy link

My personal understanding when reading the Optional in the document, is that ?type refers to an optional value, if no value assigned, it should be null, so I guess it can be used in function arguments when I don't want to assign value.

I think I'll make an issue suggesting the renaming of optional types to nullable types, to me at least that'd seem less confusing.

For your Image struct, I'd maybe make it so readFromFile returns the image it loaded, so you can do const image = try Image.readFromFile(...);. Alternatively, you could add good default values (like you already have, with 0, 0 and &.{}) and then rewrite the first line in the readFromFile example to var image: Image = .{}; to use the default, empty image.

> My personal understanding when reading the Optional in the document, is that ?type refers to an optional value, if no value assigned, it should be null, so I guess it can be used in function arguments when I don't want to assign value. I think I'll make an issue suggesting the renaming of *optional types* to *nullable types*, to me at least that'd seem less confusing. For your `Image` struct, I'd maybe make it so `readFromFile` returns the image it loaded, so you can do `const image = try Image.readFromFile(...);`. Alternatively, you could add good default values (like you already have, with `0`, `0` and `&.{}`) and then rewrite the first line in the `readFromFile` example to `var image: Image = .{};` to use the default, empty image.

Not a maintainer, but:

just wanted to mention that Zig doesn't accept language proposals at this time.

Language proposals are not accepted. Please do not open an issue proposing to change the Zig language or syntax.

In future, if you have any questions about your code/improvements, Zig communities got you covered.

Not a maintainer, but: just wanted to mention that Zig [doesn't accept language proposals](https://codeberg.org/ziglang/zig#find-a-contributor-friendly-issue) at this time. > Language proposals are not accepted. Please do not open an issue proposing to change the Zig language or syntax. In future, if you have any questions about your code/improvements, [Zig communities](https://ziglang.org/community/) got you covered.

Thanks, I'd like to remain init by returning .{} and use image.readFromFile() to setup the image.

By the way I'm wondering when will the stable version (1.0) come out?

Thanks, I'd like to remain `init` by returning `.{}` and use `image.readFromFile()` to setup the image. By the way I'm wondering when will the stable version (1.0) come out?

@jgonet oh, sorry, I'd like to close that

@jgonet oh, sorry, I'd like to close that
Contributor
Copy link

@aliferne wrote in #30678 (comment):

By the way I'm wondering when will the stable version (1.0) come out?

1.0 will come out when it's "ready" (quoted from Andrew Kelley). The Zig core team doesn't want to rush to 1.0 and wants to ensure everything is great (so that they regret as few decisions as possible when the first "language stable" release is actually out and you can't really change stuff anymore).
On GitHub, there was once a milestone of (bigger) issues that need to be fixed before 1.0. I think that included stuff like formal specification of the Zig programming language, making the main Zig executable no longer depend on LLVM for as much stuff as possible (maybe not the best optimizations, but faster compilations speeds, incremental compilation etc.), a full audit of the standard library + compiler-rt (ensuring stuff is actually usable etc.) and I'm sure I forgot thousand other things.
Suffice it to say, it will not come out in the next year.

@aliferne wrote in https://codeberg.org/ziglang/zig/issues/30678#issuecomment-9538778: > By the way I'm wondering when will the stable version (1.0) come out? 1.0 will come out when it's "ready" (quoted from Andrew Kelley). The Zig core team doesn't want to rush to 1.0 and wants to ensure everything is great (so that they regret as few decisions as possible when the first "language stable" release is actually out and you can't really change stuff anymore). On GitHub, there was once a milestone of (bigger) issues that need to be fixed before 1.0. I think that included stuff like formal specification of the Zig programming language, making the main Zig executable no longer depend on LLVM for as much stuff as possible (maybe not the best optimizations, but faster compilations speeds, incremental compilation etc.), a full audit of the standard library + compiler-rt (ensuring stuff is actually usable etc.) and I'm sure I forgot thousand other things. Suffice it to say, it will *not* come out in the next year.
Sign in to join this conversation.
No Branch/Tag specified
master
elfv2
spork8
restricted
0.16.x
panic-rewrite
parking-futex-lockfree
windows-Io-cleanup
Io-watch
ParseCommandLineOptions
windows-async-files
poll-ring
debug-file-leaks-differently
debug-file-leaks
ProcessPrng
elfv2-dyn
jobserver
threadtheft
io-threaded-no-queue
0.15.x
Io.net
comptime-allocator
restricted-function-pointers
cli
wasm-linker-writer
wrangle-writer-buffering
sha1-stream
async-await-demo
fixes
0.14.x
ast-node-methods
macos-debug-info
make-vs-configure
fuzz-macos
sans-aro
ArrayList-reserve
incr-bug
llvm-ir-nosanitize-metadata
ci-tarballs
ci-scripts
threadpool
0.12.x
new-pkg-hash
json-diagnostics
more-doctests
rework-comptime-mutation
0.11.x
ci-perf-comment
stage2-async
0.10.x
autofix
0.9.x
aro
hcs
0.8.x
0.7.x
0.16.0
0.15.2
0.15.1
0.15.0
0.14.1
0.14.0
0.12.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.1
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.1
0.1.0
Labels
Clear labels
abi/f32
abi/ilp32
abi/sf
accepted
This proposal is planned.
arch/21k
arch/6502
arch/aarch64
arch/alpha
arch/amdgcn
arch/arc
arch/arc32
arch/arc64
arch/arm
arch/avr
arch/bfin
arch/bpf
arch/colossus
arch/cris
arch/csky
arch/dlx
arch/epiphany
arch/fr30
arch/frv
arch/hexagon
arch/hppa
arch/hppa64
arch/ia64
arch/kalimba
arch/kvx
arch/lanai
arch/lm32
arch/loongarch32
arch/loongarch64
arch/m32r
arch/m68k
arch/m88k
arch/mcore
arch/microblaze
arch/mips
arch/mips64
arch/mmix
arch/moxie
arch/mrisc32
arch/msp430
arch/nds32
arch/ns32k
arch/nvptx
arch/or1k
arch/powerpc
arch/powerpc64
arch/propeller
arch/riscv32
arch/riscv64
arch/rl78
arch/rx
arch/s390x
arch/sh
arch/sparc
arch/sparc64
arch/spirv
arch/spu
arch/tricore
arch/v850
arch/vax
arch/vc4
arch/ve
arch/wasm
arch/x86
arch/x86_64
arch/xcore
arch/xtensa
autodoc
The web application for interactive documentation and generation of its assets.
backend/c
The C backend outputs C source code.
backend/llvm
The LLVM backend outputs an LLVM bitcode module.
backend/self-hosted
The self-hosted backends produce machine code directly.
binutils
Zig's included binary utilities: zig ar, zig dlltool, zig lib, zig ranlib, zig objcopy, and zig rc.
breaking
Implementing this issue could cause existing code to no longer compile or have different behavior.
build system
The Zig build system - zig build, std.Build, the build runner, and package management.
debug info
An issue related to debug information (e.g. DWARF) produced by the Zig compiler.
docs
An issue with documentation, e.g. the language reference or standard library doc comments.
error message
This issue points out an error message that is unhelpful and should be improved.
frontend
Tokenization, parsing, AstGen, ZonGen, Sema, Legalize, and Liveness.
fuzzing
An issue related to Zig's integrated fuzz testing.
incremental
Reuse of internal compiler state for faster compilation.
lib/c
This issue relates to Zig's libc implementation and/or vendored libcs.
lib/compiler-rt
This issue relates to Zig's compiler-rt library.
lib/cxx
This issue relates to Zig's vendored libc++ and/or libc++abi.
lib/std
This issue relates to Zig's standard library.
lib/tsan
This issue relates to Zig's vendored libtsan.
lib/ubsan-rt
This issue relates to Zig's ubsan-rt library.
lib/unwind
This issue relates to Zig's vendored libunwind.
linking
Zig's integrated object file and incremental linker.
miscompilation
The compiler reports success but produces semantically incorrect code.
os/android
os/contiki
os/dragonfly
os/driverkit
os/emscripten
os/freebsd
os/fuchsia
os/haiku
os/hermit
os/hurd
os/illumos
os/ios
os/linux
os/maccatalyst
os/macos
os/managarm
os/netbsd
os/ohos
os/openbsd
os/plan9
os/redox
os/rtems
os/serenity
os/tvos
os/uefi
os/visionos
os/wasi
os/watchos
os/windows
proposal
This issue suggests language modifications. If it also has the "accepted" label then it is planned.
release notes
This issue or pull request should be mentioned in the release notes.
testing
This issue is related to testing the compiler, standard library, or other parts of Zig.
zig cc
Zig as a drop-in C-family compiler.
zig fmt
The Zig source code formatter.
zig reduce
The Zig source code reduction tool.
bounty
https://ziglang.org/news/announcing-donor-bounties
bug
Observed behavior contradicts documented or intended behavior.
contributor-friendly
This issue is limited in scope and/or knowledge of project internals.
downstream
An issue with a third-party project that uses this project.
enhancement
Solving this issue will likely involve adding new logic or components to the codebase.
infra
An issue related to project infrastructure, e.g. continuous integration.
optimization
A task to improve performance and/or resource usage.
question
No questions on the issue tracker; use a community space instead.
regression
Something that used to work in a previous version stopped working
upstream
An issue with a third-party project that this project uses.
use case
Describes a real use case that is difficult or impossible, but does not propose a solution.
No labels
abi/f32
abi/ilp32
abi/sf
accepted
arch/21k
arch/6502
arch/aarch64
arch/alpha
arch/amdgcn
arch/arc
arch/arc32
arch/arc64
arch/arm
arch/avr
arch/bfin
arch/bpf
arch/colossus
arch/cris
arch/csky
arch/dlx
arch/epiphany
arch/fr30
arch/frv
arch/hexagon
arch/hppa
arch/hppa64
arch/ia64
arch/kalimba
arch/kvx
arch/lanai
arch/lm32
arch/loongarch32
arch/loongarch64
arch/m32r
arch/m68k
arch/m88k
arch/mcore
arch/microblaze
arch/mips
arch/mips64
arch/mmix
arch/moxie
arch/mrisc32
arch/msp430
arch/nds32
arch/ns32k
arch/nvptx
arch/or1k
arch/powerpc
arch/powerpc64
arch/propeller
arch/riscv32
arch/riscv64
arch/rl78
arch/rx
arch/s390x
arch/sh
arch/sparc
arch/sparc64
arch/spirv
arch/spu
arch/tricore
arch/v850
arch/vax
arch/vc4
arch/ve
arch/wasm
arch/x86
arch/x86_64
arch/xcore
arch/xtensa
autodoc
backend/c
backend/llvm
backend/self-hosted
binutils
breaking
build system
debug info
docs
error message
frontend
fuzzing
incremental
lib/c
lib/compiler-rt
lib/cxx
lib/std
lib/tsan
lib/ubsan-rt
lib/unwind
linking
miscompilation
os/android
os/contiki
os/dragonfly
os/driverkit
os/emscripten
os/freebsd
os/fuchsia
os/haiku
os/hermit
os/hurd
os/illumos
os/ios
os/linux
os/maccatalyst
os/macos
os/managarm
os/netbsd
os/ohos
os/openbsd
os/plan9
os/redox
os/rtems
os/serenity
os/tvos
os/uefi
os/visionos
os/wasi
os/watchos
os/windows
proposal
release notes
testing
zig cc
zig fmt
zig reduce
bounty
bug
contributor-friendly
downstream
enhancement
infra
optimization
question
regression
upstream
use case
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ziglang/zig#30678
Reference in a new issue
ziglang/zig
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?