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 › debug › Dwarf › Unwind › EhFrameHeader › parse Public Function parse Doc Source Public Function std.debug.Dwarf.Unwind.EhFrameHeader.parse
pub fn parse (
eh_frame_hdr_vaddr : u64 ,
eh_frame_hdr_bytes : []const u8 ,
addr_size_bytes : u8 ,
endian : Endian ,
) !EhFrameHeader Params eh_frame_hdr_vaddr : u64 eh_frame_hdr_bytes : []const u8 addr_size_bytes : u8 endian : Endian File debug/Dwarf/Unwind.zig: 192
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233 pub fn parse (
eh_frame_hdr_vaddr : u64 ,
eh_frame_hdr_bytes : []const u8 ,
addr_size_bytes : u8 ,
endian : Endian ,
) !EhFrameHeader {
var r : Reader = .fixed (eh_frame_hdr_bytes );
const version = try r .takeByte ();
if (version != 1 ) return bad ();
const eh_frame_ptr_enc : EH .PE = @bitCast (try r .takeByte ());
const fde_count_enc : EH .PE = @bitCast (try r .takeByte ());
const table_enc : EH .PE = @bitCast (try r .takeByte ());
const eh_frame_ptr = try readEhPointer (&r , eh_frame_ptr_enc , addr_size_bytes , .{
.pc_rel_base = eh_frame_hdr_vaddr + r .seek ,
}, endian );
const table : ?SearchTable = table : {
if (fde_count_enc == EH .PE .omit ) break :table null ;
if (table_enc == EH .PE .omit ) break :table null ;
const fde_count = try readEhPointer (&r , fde_count_enc , addr_size_bytes , .{
.pc_rel_base = eh_frame_hdr_vaddr + r .seek ,
}, endian );
const entry_size = try SearchTable .entrySize (table_enc , addr_size_bytes );
const bytes_offset = r .seek ;
const bytes_len = cast (usize , fde_count * entry_size ) orelse return error .EndOfStream ;
const bytes = try r .take (bytes_len );
break :table .{
.encoding = table_enc ,
.fde_count = @intCast (fde_count ),
.entries = bytes ,
.offset = @intCast (bytes_offset ),
};
};
return .{
.eh_frame_vaddr = eh_frame_ptr ,
.search_table = table ,
};
}