Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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. Public Struct

Context

Public Struct
std.debug.Dwarf.expression.Context
pub const Context = struct

Expressions can be evaluated in different contexts, each requiring its own set of inputs. Callers should specify all the fields relevant to their context. If a field is required by the expression and it isn't in the context, error.IncompleteExpressionContext is returned.

Fields

format: std.dwarf.Format = .@"32"

The dwarf format of the section this expression is in

compile_unit: ?*const std.debug.Dwarf.CompileUnit = null

The compilation unit this expression relates to, if any

object_address: ?*const anyopaque = null

When evaluating a user-presented expression, this is the address of the object being evaluated

debug_addr: ?[]const u8 = null

.debug_addr section

cpu_context: ?*std.debug.cpu_context.Native = null
cfa: ?usize = null

Call frame address, if in a CFI context

entry_value_context: bool = false

This expression is a sub-expression from an OP.entry_value instruction

File

debug/Dwarf/expression.zig:22
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
pub const Context = struct {
    /// The dwarf format of the section this expression is in
    format: std.dwarf.Format = .@"32",
    /// The compilation unit this expression relates to, if any
    compile_unit: ?*const std.debug.Dwarf.CompileUnit = null,
    /// When evaluating a user-presented expression, this is the address of the object being evaluated
    object_address: ?*const anyopaque = null,
    /// .debug_addr section
    debug_addr: ?[]const u8 = null,
    cpu_context: ?*std.debug.cpu_context.Native = null,
    /// Call frame address, if in a CFI context
    cfa: ?usize = null,
    /// This expression is a sub-expression from an OP.entry_value instruction
    entry_value_context: bool = false,
}