/ 
HTTP-Promise-v0.5.2
River stage one • 2 direct dependents • 3 total dependents
/ HTTP::Promise::Body

NAME

HTTP::Promise::Body - HTTP Message Body Class

SYNOPSIS

use HTTP::Promise::Body;
my $body = HTTP::Promise::Body->new || 
    die( HTTP::Promise::Body->error, "\n" );

VERSION

v0.1.0

DESCRIPTION

This class represents an entity body.

Here is how it fits in overall relation with other classes.

+-------------------------+    +--------------------------+    
|                         |    |                          |    
| HTTP::Promise::Request  |    | HTTP::Promise::Response  |    
|                         |    |                          |    
+------------|------------+    +-------------|------------+    
             |                               |                 
             |                               |                 
             |                               |                 
             |  +------------------------+   |                 
             |  |                        |   |                 
             +--- HTTP::Promise::Message |---+                 
                |                        |                     
                +------------|-----------+                     
                             |                                 
                             |                                 
                +------------|-----------+                     
                |                        |                     
                | HTTP::Promise::Entity  |                     
                |                        |                     
                +------------|-----------+                     
                             |                                 
                             |                                 
                +------------|-----------+                     
                |                        |                     
                | HTTP::Promise::Body    |                     
                |                        |                     
                +------------------------+

METHODS

as_lines

Returns a new array object containing the body lines.

as_string

Returns the body data as a scalar object.

Be mindful about the size of the body before you load it all in memory. You can get the size of the body with $body->length

data

This is just an alias for "as_string"

dup

This is an alias for "clone" in Module::Generic, which is inherited by this class.

path

This is a no-op and is superseded by inheriting classes.

print

Provided with a filehandle, or an HTTP::Promise::IO object and an hash or hash reference of options and this will print the body data to and returns true if it was successful, or sets an error and returns undef

purge

This is a no-op and is superseded by inheriting classes.

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

HTTP::Promise, HTTP::Promise::Request, HTTP::Promise::Response, HTTP::Promise::Message, HTTP::Promise::Entity, HTTP::Promise::Headers, HTTP::Promise::Body, HTTP::Promise::Body::Form, HTTP::Promise::Body::Form::Data, HTTP::Promise::Body::Form::Field, HTTP::Promise::Status, HTTP::Promise::MIME, HTTP::Promise::Parser, HTTP::Promise::IO, HTTP::Promise::Stream, HTTP::Promise::Exception

Module::Generic::File, Module::Generic::Scalar, Module::Generic::File::IO, Module::Generic::Scalar::IO

PerlIO::scalar

COPYRIGHT & LICENSE

Copyright(c) 2022 DEGUEST Pte. Ltd.

All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.