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 › Dispatch › BatchOperationUserdata Private Struct BatchOperationUserdata Doc Source Private Struct std.Io.Dispatch.BatchOperationUserdata
const BatchOperationUserdata = extern struct Fields batch : *Io .Batch source : c .dispatch .source_t operation : extern union { file_read_streaming : extern struct { data_ptr : [*]const []u8 , data_len : usize , }, file_write_streaming : extern struct { header_ptr : [*]const u8 , header_len : usize , data_ptr : [*]const []const u8 , data_len : usize , splat : usize , fn header (operation : *const @This ()) []const u8 { return operation .header_ptr [0 ..operation .header_len ]; } fn data (operation : *const @This ()) []const []const u8 { return operation .data_ptr [0 ..operation .data_len ]; } }, } Values Functions File Io/Dispatch.zig: 2002
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040 const BatchOperationUserdata = extern struct {
batch : *Io .Batch ,
source : c .dispatch .source_t ,
operation : extern union {
file_read_streaming : extern struct {
data_ptr : [*]const []u8 ,
data_len : usize ,
},
file_write_streaming : extern struct {
header_ptr : [*]const u8 ,
header_len : usize ,
data_ptr : [*]const []const u8 ,
data_len : usize ,
splat : usize ,
fn header (operation : *const @This ()) []const u8 {
return operation .header_ptr [0 ..operation .header_len ];
}
fn data (operation : *const @This ()) []const []const u8 {
return operation .data_ptr [0 ..operation .data_len ];
}
},
},
const Erased = Io .Operation .Storage .Pending .Userdata ;
comptime {
assert (@sizeOf (BatchOperationUserdata ) <= @sizeOf (Erased ));
}
fn toErased (userdata : *BatchOperationUserdata ) *Erased {
return @ptrCast (userdata );
}
fn fromErased (erased : *Erased ) *BatchOperationUserdata {
return @ptrCast (erased );
}
}