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 › fmt › parse_float › FloatStream Public Struct FloatStream Doc Source Public Struct Fields slice : []const u8 offset : usize underscore_count : usize Namespaces Values Functions File fmt/parse_float/FloatStream.zig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120 //! A wrapper over a byte-slice, providing useful methods for parsing string floating point values.
const std = @import ("std " );
const FloatStream = @This ();
const common = @import ("common.zig " );
slice : []const u8 ,
offset : usize ,
underscore_count : usize ,
pub fn init (s : []const u8 ) FloatStream return .{ .slice = s , .offset = 0 , .underscore_count = 0 };
}
// Returns the offset from the start *excluding* any underscores that were found.
pub fn offsetTrue (self : FloatStream usize {
return self .offset - self .underscore_count ;
}
pub fn reset (self : *FloatStream void {
self .offset = 0 ;
self .underscore_count = 0 ;
}
pub fn len (self : FloatStream usize {
if (self .offset > self .slice .len ) {
return 0 ;
}
return self .slice .len - self .offset ;
}
pub fn hasLen (self : FloatStream n : usize ) bool {
return self .offset + n <= self .slice .len ;
}
pub fn firstUnchecked (self : FloatStream u8 {
return self .slice [self .offset ];
}
pub fn first (self : FloatStream u8 {
return if (self .hasLen (1 ))
return self .firstUnchecked ()
else
null ;
}
pub fn isEmpty (self : FloatStream bool {
return !self .hasLen (1 );
}
pub fn firstIs (self : FloatStream comptime cs : []const u8 ) bool {
if (self .first ()) |ok | {
inline for (cs ) |c | if (ok == c ) return true ;
}
return false ;
}
pub fn firstIsLower (self : FloatStream comptime cs : []const u8 ) bool {
if (self .first ()) |ok | {
inline for (cs ) |c | if (ok | 0x20 == c ) return true ;
}
return false ;
}
pub fn firstIsDigit (self : FloatStream comptime base : u8 ) bool {
comptime std debug assert base == 10 or base == 16 );
if (self .first ()) |ok | {
return common isDigit ok , base );
}
return false ;
}
pub fn advance (self : *FloatStream n : usize ) void {
self .offset += n ;
}
pub fn skipChars (self : *FloatStream comptime cs : []const u8 ) void {
while (self .firstIs (cs )) : (self .advance (1 )) {}
}
pub fn readU64Unchecked (self : FloatStream u64 {
return std mem readInt u64 , self .slice [self .offset ..][0 ..8 ], .little );
}
pub fn readU64 (self : FloatStream u64 {
if (self .hasLen (8 )) {
return self .readU64Unchecked ();
}
return null ;
}
pub fn atUnchecked (self : *FloatStream i : usize ) u8 {
return self .slice [self .offset + i ];
}
pub fn scanDigit (self : *FloatStream comptime base : u8 ) ?u8 {
comptime std debug assert base == 10 or base == 16 );
retry : while (true ) {
if (self .first ()) |ok | {
if ('0' <= ok and ok <= '9' ) {
self .advance (1 );
return ok - '0' ;
} else if (base == 16 and 'a' <= ok and ok <= 'f' ) {
self .advance (1 );
return ok - 'a' + 10 ;
} else if (base == 16 and 'A' <= ok and ok <= 'F' ) {
self .advance (1 );
return ok - 'A' + 10 ;
} else if (ok == '_' ) {
self .advance (1 );
self .underscore_count += 1 ;
continue :retry ;
}
}
return null ;
}
}
A wrapper over a byte-slice, providing useful methods for parsing string floating point values.