The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Store-Digest-0.04
River stage zero No dependents
++
/ Store::Digest::Driver

NAME

Store::Digest::Driver - Driver role for Store::Digest

VERSION

Version 0.01

SYNOPSIS

METHODS

new

Create a new store, or bind to an existing one.

get

    my $obj = $driver->get('sha-256' => $digest);

    # or

    my $obj = $driver->get($uri); # a URI::ni object

Get an object from the store

about

Get metadata about the store itself

add

    my $obj = $driver->add(
        content  => $fh,
        language => 'en',
        mtime    => $datetime,
    );

Add an object to the store

returns a metadata object

remove

    my $obj = $driver->remove('sha-256' => $digest);

    # $obj->content will be undef and $obj->dtime will be set

Remove an object from the store, leaving its metadata

forget

    my $ok = $driver->forget('sha-256' => $digest);

Forget about an object in addition to removing it. Ordinarily, removing an object will only delete the content and preserve the metadata.

list

List the objects in the store

algorithm

Which cryptographic algorithm to be used as a key

start

Starting offset, beginning with 1

end

Ending offset, which should be equal to or larger than the starting offset.

sort

Which field to use to sort the list

invert

Whether or not to invert the list

stats

Retrieve statistics on the store

AUTHOR

Dorian Taylor, <dorian at cpan.org>

BUGS

Please report any bugs or feature requests to bug-store-digest at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Store-Digest. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Store::Digest::Driver

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2012 Dorian Taylor.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.