BOTAN(3em)

🌸 NAME 🌸

Okay bestie, welcome to BOTAN(3em) — this is the manual page for botan, aka the Botan bindings for Emilua. It’s giving “I know my hash functions and I’m gonna make it cute” 💅✨

---

✨ SYNOPSIS ✨

local hash_function = require "botan".hash_function

---

🫶 FUNCTIONS 🫶

create(algo_spec: string[, provider: string]) → hash_function|nil

Returns a newly allocated hash function object, or nil if algo_spec is not recognized. The optional provider: string is right there in the signature too, bestie 🦋

create_or_throw(algo_spec: string[, provider: string]) → hash_function

Like create, except that it will throw an exception instead of returning nil. So if you want drama when it fails, this is your girl 😭🔥

providers(algo_spec: string) → string[]

Returns the list of available providers for this algorithm, empty if not available. Literally an empty list if it’s not available — no cap 🌸

update(self, input: byte_span|string)

Updates the computation with input. Feed it the data, bestie 💖

final(self)

function final(self, out: byte_span)     (1)
function final(self) -> secure_byte_span (2)

1. Place the result into out. Exactly output_length bytes will be written.
2. Returns the result in a newly allocated secure_byte_span.

Finalize the calculation. After you call final, the algorithm is reset to its initial state, so it may be reused immediately. Reusable queen behavior 👑✨

process(self, input: byte_span|string) → secure_byte_span

Equivalent to calling update followed by final. One-stop shop, no extra steps 🎀

new_object(self) → hash_function

Return a newly allocated HashFunction object of the same type as this one.

copy_state(self) → hash_function

Return a newly allocated HashFunction object of the same type as this one, whose internal state matches the current state of this. It’s giving clone-but-make-it-accurate 💅

clear(self)

Reset the state. Clean slate, fresh vibe, periodt 🌈

---

💖 PROPERTIES 💖

• output_length: integer — The size (in bytes) of the output of this function.
• name: string — The hash function name.
• provider: string — Provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.
• hash_block_size: integer — Hash block size as defined for this algorithm.

---

And that’s the whole iconic page, bestie 💋 — it comes from Emilua 0.12.1, dated 1980-01-01, and it’s the BOTAN(3em) manual. Bye fr fr 🎀✨