Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › Io › Threaded › Future › create Private Function create Doc Source Private Function std.Io.Threaded.Future.create
fn create (
gpa : Allocator ,
result_len : usize ,
result_alignment : Alignment ,
context : []const u8 ,
context_alignment : Alignment ,
func : *const fn (context : *const anyopaque , result : *anyopaque ) void ,
) Allocator .Error !*Future Params gpa : Allocator result_len : usize result_alignment : Alignment context : []const u8 context_alignment : Alignment func : *const fn (context : *const anyopaque , result : *anyopaque ) void File Io/Threaded.zig: 664
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700 fn create (
gpa : Allocator ,
result_len : usize ,
result_alignment : Alignment ,
context : []const u8 ,
context_alignment : Alignment ,
func : *const fn (context : *const anyopaque , result : *anyopaque ) void ,
) Allocator .Error !*Future {
const max_context_misalignment = context_alignment .toByteUnits () -| @alignOf (Future );
const worst_case_context_offset = context_alignment .forward (@sizeOf (Future ) + max_context_misalignment );
const worst_case_result_offset = result_alignment .forward (worst_case_context_offset + context .len );
const alloc_len = worst_case_result_offset + result_len ;
const future : *Future = @ptrCast (@alignCast (try gpa .alignedAlloc (u8 , .of (Future ), alloc_len )));
errdefer comptime unreachable ;
const actual_context_addr = context_alignment .forward (@intFromPtr (future ) + @sizeOf (Future ));
const actual_result_addr = result_alignment .forward (actual_context_addr + context .len );
const actual_result_offset = actual_result_addr - @intFromPtr (future );
future .* = .{
.runnable = .{
.node = undefined ,
.startFn = &start ,
},
.func = func ,
.status = .init (.{
.tag = .pending ,
.thread = .null ,
}),
.awaiter = undefined ,
.context_alignment = context_alignment ,
.result_offset = actual_result_offset ,
.alloc_len = alloc_len ,
};
@memcpy (future .contextPointer ()[0 ..context .len ], context );
return future ;
}
Future.runnable.nodeisundefinedin the createdFuture.