143 lines
3.1 KiB
Perl
143 lines
3.1 KiB
Perl
package Mojo::Asset;
|
|
use Mojo::Base 'Mojo::EventEmitter';
|
|
|
|
use Carp qw(croak);
|
|
|
|
has 'end_range';
|
|
has start_range => 0;
|
|
|
|
sub add_chunk { croak 'Method "add_chunk" not implemented by subclass' }
|
|
sub contains { croak 'Method "contains" not implemented by subclass' }
|
|
sub get_chunk { croak 'Method "get_chunk" not implemented by subclass' }
|
|
|
|
sub is_file {undef}
|
|
|
|
sub is_range { !!($_[0]->end_range || $_[0]->start_range) }
|
|
|
|
sub move_to { croak 'Method "move_to" not implemented by subclass' }
|
|
sub mtime { croak 'Method "mtime" not implemented by subclass' }
|
|
sub size { croak 'Method "size" not implemented by subclass' }
|
|
sub slurp { croak 'Method "slurp" not implemented by subclass' }
|
|
sub to_file { croak 'Method "to_file" not implemented by subclass' }
|
|
|
|
1;
|
|
|
|
=encoding utf8
|
|
|
|
=head1 NAME
|
|
|
|
Mojo::Asset - HTTP content storage base class
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
package Mojo::Asset::MyAsset;
|
|
use Mojo::Base 'Mojo::Asset';
|
|
|
|
sub add_chunk {...}
|
|
sub contains {...}
|
|
sub get_chunk {...}
|
|
sub move_to {...}
|
|
sub mtime {...}
|
|
sub size {...}
|
|
sub slurp {...}
|
|
sub to_file {...}
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
L<Mojo::Asset> is an abstract base class for HTTP content storage backends, like L<Mojo::Asset::File> and
|
|
L<Mojo::Asset::Memory>.
|
|
|
|
=head1 EVENTS
|
|
|
|
L<Mojo::Asset> inherits all events from L<Mojo::EventEmitter>.
|
|
|
|
=head1 ATTRIBUTES
|
|
|
|
L<Mojo::Asset> implements the following attributes.
|
|
|
|
=head2 end_range
|
|
|
|
my $end = $asset->end_range;
|
|
$asset = $asset->end_range(8);
|
|
|
|
Pretend file ends earlier.
|
|
|
|
=head2 start_range
|
|
|
|
my $start = $asset->start_range;
|
|
$asset = $asset->start_range(3);
|
|
|
|
Pretend file starts later.
|
|
|
|
=head1 METHODS
|
|
|
|
L<Mojo::Asset> inherits all methods from L<Mojo::EventEmitter> and implements the following new ones.
|
|
|
|
=head2 add_chunk
|
|
|
|
$asset = $asset->add_chunk('foo bar baz');
|
|
|
|
Add chunk of data to asset. Meant to be overloaded in a subclass.
|
|
|
|
=head2 contains
|
|
|
|
my $position = $asset->contains('bar');
|
|
|
|
Check if asset contains a specific string. Meant to be overloaded in a subclass.
|
|
|
|
=head2 get_chunk
|
|
|
|
my $bytes = $asset->get_chunk($offset);
|
|
my $bytes = $asset->get_chunk($offset, $max);
|
|
|
|
Get chunk of data starting from a specific position, defaults to a maximum chunk size of C<131072> bytes (128KiB).
|
|
Meant to be overloaded in a subclass.
|
|
|
|
=head2 is_file
|
|
|
|
my $bool = $asset->is_file;
|
|
|
|
False, this is not a L<Mojo::Asset::File> object.
|
|
|
|
=head2 is_range
|
|
|
|
my $bool = $asset->is_range;
|
|
|
|
Check if asset has a L</"start_range"> or L</"end_range">.
|
|
|
|
=head2 move_to
|
|
|
|
$asset = $asset->move_to('/home/sri/foo.txt');
|
|
|
|
Move asset data into a specific file. Meant to be overloaded in a subclass.
|
|
|
|
=head2 mtime
|
|
|
|
my $mtime = $asset->mtime;
|
|
|
|
Modification time of asset. Meant to be overloaded in a subclass.
|
|
|
|
=head2 size
|
|
|
|
my $size = $asset->size;
|
|
|
|
Size of asset data in bytes. Meant to be overloaded in a subclass.
|
|
|
|
=head2 slurp
|
|
|
|
my $bytes = $asset->slurp;
|
|
|
|
Read all asset data at once. Meant to be overloaded in a subclass.
|
|
|
|
=head2 to_file
|
|
|
|
my $file = $asset->to_file;
|
|
|
|
Convert asset to L<Mojo::Asset::File> object. Meant to be overloaded in a subclass.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<Mojolicious>, L<Mojolicious::Guides>, L<https://mojolicious.org>.
|
|
|
|
=cut
|