/ 
File-Information-v0.04
River stage zero No dependents
/ File::Information::VerifyBase

NAME

File::Information::VerifyBase - generic module for extracting information from filesystems

VERSION

version v0.04

SYNOPSIS

use File::Information;

my File::Information::VerifyBase $base = ...;

my $passed = $base->is_passed;

This package contains the basic methods for verify results. See also "verify" in File::Information::Base.

METHODS

status

my $status = $obj->status;

Returns the status of the test. Most commonly one want to check for the passed state using "has_passed".

has_error

my $has_error = $obj->has_error;

Returns if the status is the error status. That is the test was not performed (likely due to an internal error or an operating system error).

Note: This is not the opposite of "has_passed".

has_passed

my $has_passed = $obj->has_passed;

This will return if the test was successfully passed. That is the data is available and matched the expected value.

Note: This is not the opposite of "has_failed" or "has_error".

has_failed

my $has_failed = $obj->has_failed;

Returns if the status is the failed status. That is the test was successfully performed but the data did not match.

Note: This is not the opposite of "has_passed".

has_no_data

my $has_no_data = $obj->has_no_data;

Returns true if the test was not performed due to missing data.

has_insufficient_data

my $has_insufficient_data = $obj->has_insufficient_data;

Returnes true if the test was performed but there is data missing for it to pass. The parts that have been performed did not fail.

base

my File::Information::Base $base = $obj->base;

Returns the base that was used to create this object.

instance

my File::Information $instance = $obj->instance;

Returns the instance that was used to create this object.

extractor, db

my Data::URIID $extractor = $obj->extractor;
my Data::TagDB $db        = $obj->db;
my ...                    = $obj->digest_info;

These methods provide access to the same data as the methods of File::Information. Arguments will be passed to said functions. However the object my cache the result. Therefore it is only allowed to pass arguments that are compatible with caching (if any exist).

See "extractor" in File::Information, and "db" in File::Information for details.

AUTHOR

Löwenfelsen UG (haftungsbeschränkt) <support@loewenfelsen.net>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2024 by Löwenfelsen UG (haftungsbeschränkt) <support@loewenfelsen.net>.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)