shishi_safe(3)

📦
version 1.0.3 · 2 versions
  • 1.0.3 · debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.0.2 · ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ shishi_safe ✨

okay bestie, gather round, because we're doing a shishi_safe(3) deep dive and honestly? it's giving main character energy for the whole shishi library. this is one of the shishi man pages, and she's a tiny little function with a very important job. let's get into it 🫶

🌸 NAME 🌸

shishi_safe — it's an API function, bestie. that's the whole vibe. no cap. 💅

🎀 SYNOPSIS 🎀

here's how you summon her:

#include <shishi.h>

int shishi_safe(Shishi * handle, Shishi_safe ** safe);

look at that signature. so clean. so iconic. ✨

🦋 ARGUMENTS 🦋

two args, both required, both important, let's go:

  • Shishi * handle — this is your shishi handle, and the way you got it is by calling shishi_init(). that's the origin story, that's the lore. 🧚
  • Shishi_safe ** safe — a pointer to a brand new structure that holds all the info about the SAFE exchange. it's a double pointer, so yes, she's fancy. periodt. 👑

💖 DESCRIPTION 💖

so what does she do? literally one thing and she does it flawlessly:

Create a new SAFE exchange.

that's it. that's the function. new SAFE exchange, freshly made, just for you. slay 🌈

⭐ RETURN VALUE ⭐

she returns SHISHI_OK iff it's successful. that's the good outcome, the one you want, the green flag 🟢. iykyk.

😭 REPORTING BUGS 😭

found a bug? not me manifesting problems but like, it happens. here's where to send it:

don't be shy, they wanna hear from you fr fr 🙈

Copyright © 2002-2022 Simon Josefsson.

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.

like, go ahead, share the love, just keep the receipts bestie 🎀

🌈 SEE ALSO 🌈

the full documentation for shishi is maintained as a Texinfo manual — yes, a whole manual, the extended universe, the director's cut 👑

if the info and shishi programs are properly installed at your site, this command:

info shishi

should give you access to the complete manual. so go read it, it's the sequel and it eats 💅

okay that's the whole page, you're officially educated on shishi_safe and honestly? obsessed. this was shishi version 1.0.3, from the shishi_safe(3) page — go forth and make safe exchanges, bestie, ily 🫶✨💖

📦 where this page comes from