From: Charles McGarvey Date: Mon, 2 May 2022 06:20:02 +0000 (-0600) Subject: Tweak documentation X-Git-Tag: v0.901~2 X-Git-Url: https://git.dogcows.com/gitweb?a=commitdiff_plain;h=84a35b3fe4421abbe930586dd3a214cbb15da9b7;p=chaz%2Fp5-File-KDBX Tweak documentation --- diff --git a/lib/File/KDBX.pm b/lib/File/KDBX.pm index 4151891..255958a 100644 --- a/lib/File/KDBX.pm +++ b/lib/File/KDBX.pm @@ -1155,11 +1155,11 @@ our %PLACEHOLDERS = ( $kdbx->lock; -Encrypt all protected binaries strings in a database. The encrypted strings are stored in -a L associated with the database and the actual strings will be replaced with C to +Encrypt all protected strings and binaries in a database. The encrypted data is stored in +a L associated with the database and the actual values will be replaced with C to indicate their protected state. Returns itself to allow method chaining. -You can call C on an already-locked database to memory-protect any unprotected strings and binaries +You can call C on an already-locked database to memory-protect any unprotected strings and binaries added after the last time the database was locked. =cut @@ -1192,8 +1192,8 @@ sub lock { $kdbx->unlock; -Decrypt all protected strings in a database, replacing C placeholders with unprotected values. Returns -itself to allow method chaining. +Decrypt all protected strings and binaries in a database, replacing C value placeholders with their +actual, unprotected values. Returns itself to allow method chaining. =cut @@ -1216,6 +1216,14 @@ C if the database is already unlocked. See L and L. +Example: + + { + my $guard = $kdbx->unlock_scoped; + ...; + } + # $kdbx is now memory-locked + =cut sub unlock_scoped { @@ -1249,13 +1257,13 @@ sub peek { $bool = $kdbx->is_locked; -Get whether or not a database's strings are memory-protected. If this is true, then some or all of the -protected strings within the database will be unavailable (literally have C values) until L is -called. +Get whether or not a database's contents are in a locked (i.e. memory-protected) state. If this is true, then +some or all of the protected strings and binaries within the database will be unavailable (literally have +C values) until L is called. =cut -sub is_locked { $_[0]->_safe ? 1 : 0 } +sub is_locked { !!$_[0]->_safe } ##############################################################################