]> Dogcows Code - chaz/p5-File-KDBX/blobdiff - lib/File/KDBX/Loader.pm
Don't open already-open files on Windows
[chaz/p5-File-KDBX] / lib / File / KDBX / Loader.pm
index 6d289be0f091e94973de72a0bfedb9d3e9cbbbe4..3a3c184f95a7e6fa661c4ce11271cc819a472e0c 100644 (file)
@@ -98,14 +98,18 @@ sub reset {
 
 =method load
 
+    $kdbx = File::KDBX::Loader->load(\$string, %options);
     $kdbx = File::KDBX::Loader->load(\$string, $key);
+    $kdbx = File::KDBX::Loader->load(*IO, %options);
     $kdbx = File::KDBX::Loader->load(*IO, $key);
+    $kdbx = File::KDBX::Loader->load($filepath, %options);
     $kdbx = File::KDBX::Loader->load($filepath, $key);
-    $kdbx = $loader->load(...); # also instance method
 
-Load a KDBX file.
+Load a KDBX file. This works as an instance or a class method. The C<$key> is either
+a L<File::KDBX::Key> or a primitive castable to a Key object. Available options:
 
-The C<$key> is either a L<File::KDBX::Key> or a primitive that can be converted to a Key object.
+=for :list
+* C<key> - Alternative way to specify C<$key>
 
 =cut
 
@@ -120,11 +124,15 @@ sub load {
 
 =method load_string
 
+    $kdbx = File::KDBX::Loader->load_string($string, %options);
     $kdbx = File::KDBX::Loader->load_string($string, $key);
+    $kdbx = File::KDBX::Loader->load_string(\$string, %options);
     $kdbx = File::KDBX::Loader->load_string(\$string, $key);
-    $kdbx = $loader->load_string(...); # also instance method
 
-Load a KDBX file from a string / memory buffer.
+Load a KDBX file from a string / memory buffer. This works as an instance or class method. Available options:
+
+=for :list
+* C<key> - Alternative way to specify C<$key>
 
 =cut
 
@@ -147,10 +155,13 @@ sub load_string {
 
 =method load_file
 
+    $kdbx = File::KDBX::Loader->load_file($filepath, %options);
     $kdbx = File::KDBX::Loader->load_file($filepath, $key);
-    $kdbx = $loader->load_file(...); # also instance method
 
-Read a KDBX file from a filesystem.
+Read a KDBX file from a filesystem. This works as an instance or class method. Available options:
+
+=for :list
+* C<key> - Alternative way to specify C<$key>
 
 =cut
 
@@ -171,11 +182,16 @@ sub load_file {
 
 =method load_handle
 
+    $kdbx = File::KDBX::Loader->load_handle($fh, %options);
     $kdbx = File::KDBX::Loader->load_handle($fh, $key);
+    $kdbx = File::KDBX::Loader->load_handle(*IO, %options);
     $kdbx = File::KDBX::Loader->load_handle(*IO, $key);
-    $kdbx->load_handle(...); # also instance method
 
-Read a KDBX file from an input stream / file handle.
+Read a KDBX file from an input stream / file handle. This works as an instance or class method. Available
+options:
+
+=for :list
+* C<key> - Alternative way to specify C<$key>
 
 =cut
 
@@ -230,26 +246,13 @@ formats:
 
 =for :list
 * C<XML> - Read the database groups and entries as XML (default)
-* C<Raw> - Read parsing and store the result in L<File::KDBX/raw>
+* C<Raw> - Read and store the result in L<File::KDBX/raw> without parsing
 
 =cut
 
 has format          => undef, is => 'ro';
 has inner_format    => 'XML', is => 'ro';
 
-=method min_version
-
-    $min_version = File::KDBX::Loader->min_version;
-
-Get the minimum KDBX file version supported, which is 3.0 or C<0x00030000> as
-it is encoded.
-
-To read older KDBX files unsupported by this module, try L<File::KeePass>.
-
-=cut
-
-sub min_version { KDBX_VERSION_OLDEST }
-
 =method read_magic_numbers
 
     $magic = File::KDBX::Loader->read_magic_numbers($fh);
This page took 0.023771 seconds and 4 git commands to generate.