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 › meta › hasUniqueRepresentation Public Function hasUniqueRepresentation Doc Source Public Function std.meta.hasUniqueRepresentation
pub inline fn hasUniqueRepresentation (comptime T : type ) bool Params File meta.zig: 914
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966 pub inline fn hasUniqueRepresentation (comptime T : type ) bool {
return switch (@typeInfo (T )) {
else => false , // TODO can we know if it's true for some of these types ?
.@"anyframe" ,
.error_set ,
.@"fn" ,
=> true ,
.bool => false ,
.@"enum" => |info | hasUniqueRepresentation (info .tag_type ),
.int => |info | @sizeOf (T ) * 8 == info .bits ,
.pointer => |info | info .size != .slice ,
.optional => |info | switch (@typeInfo (info .child )) {
.pointer => |ptr | !ptr .attrs .@"allowzero" and switch (ptr .size ) {
.slice , .c => false ,
.one , .many => true ,
},
else => false ,
},
.array => |info | hasUniqueRepresentation (info .child ),
.@"struct" => |info | {
if (info .layout == .@"packed" ) return @sizeOf (T ) * 8 == @bitSizeOf (T );
var sum_size = @as (usize , 0 );
inline for (info .field_attrs , info .field_types ) |field_attr , field_type | {
if (field_attr .@"comptime" ) continue ;
if (!hasUniqueRepresentation (field_type )) return false ;
sum_size += @sizeOf (field_type );
}
return @sizeOf (T ) == sum_size ;
},
.@"union" => |info | {
if (info .layout == .@"packed" ) return @sizeOf (T ) * 8 == @bitSizeOf (T );
inline for (info .field_types ) |field_type | {
if (@sizeOf (field_type ) != @sizeOf (T )) return false ;
if (!hasUniqueRepresentation (field_type )) return false ;
}
return true ;
},
.vector => |info | hasUniqueRepresentation (info .child ) and
@sizeOf (T ) == @sizeOf (info .child ) * info .len ,
};
}