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 › crypto › codecs › asn1 › Element Public Struct Element Doc Source Public Struct std.crypto.codecs.asn1.Element
pub const Element = struct Fields Structs Values Functions pub fn decode (bytes : []const u8 , index : Index ) DecodeError !Element Safely decode a DER/BER/CER element at index :
Ensures length uses shortest form Ensures length is within bytes Ensures length is less than std.math.maxInt(Index) File crypto/codecs/asn1.zig: 218
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277 pub const Element = struct {
tag : Tag ,
slice : Slice ,
pub const Slice = struct {
start : Index ,
end : Index ,
pub fn len (self : Slice ) Index {
return self .end - self .start ;
}
pub fn view (self : Slice , bytes : []const u8 ) []const u8 {
return bytes [self .start ..self .end ];
}
};
pub const DecodeError = error { EndOfStream , InvalidEncoding };
/// Safely decode a DER/BER/CER element at `index`:
/// - Ensures length uses shortest form
/// - Ensures length is within `bytes`
/// - Ensures length is less than `std.math.maxInt(Index)`
pub fn decode (bytes : []const u8 , index : Index ) DecodeError !Element {
if (index > bytes .len ) return error .EndOfStream ;
var reader : std .Io .Reader = .fixed (bytes [index ..]);
const tag = Tag .decode (&reader ) catch |err | switch (err ) {
error .ReadFailed => unreachable , // it's all fixed buffers
else => |e | return e ,
};
const size_or_len_size = reader .takeByte () catch |err | switch (err ) {
error .ReadFailed => unreachable , // it's all fixed buffers
else => |e | return e ,
};
const len = if (size_or_len_size < 128 )
// short form between 0-127
size_or_len_size
else blk : {
// long form between 0 and std.math.maxInt(u1024)
const len_size : u7 = @truncate (size_or_len_size );
if (len_size > @sizeOf (Index )) return error .EndOfStream ;
const len = reader .takeVarInt (Index , .big , len_size ) catch |err | switch (err ) {
error .ReadFailed => unreachable , // it's all fixed buffers
else => |e | return e ,
};
if (len < 128 ) return error .EndOfStream ; // should have used short form
break :blk len ;
};
const start = index + @as (Index , @intCast (reader .seek ));
const end = std .math .add (Index , start , len ) catch return error .EndOfStream ;
if (end > bytes .len ) return error .EndOfStream ;
return Element { .tag = tag , .slice = Slice { .start = start , .end = end } };
}
}
A decoded view.