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 library itself.

strHash

Compute a hash of a password using the scrypt key derivation function. The function returns a string that includes all the parameters required for verification.

scrypt.strHash

pub fn strHash(
    password: []const u8,
    options: HashOptions,
    out: []u8,
    io: std.Io,
) Error![]const u8

File

lib/std/crypto/scrypt.zig:539

Code

pub fn strHash(
    password: []const u8,
    options: HashOptions,
    out: []u8,
    io: std.Io,
) Error![]const u8 {
    const allocator = options.allocator orelse return Error.AllocatorRequired;
    switch (options.encoding) {
        .phc => return PhcFormatHasher.create(allocator, password, options.params, out, io),
        .crypt => return CryptFormatHasher.create(allocator, password, options.params, out, io),
    }
}