.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PGObject::Type::ByteString 3pm"
.TH PGObject::Type::ByteString 3pm "2022-11-21" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
PGObject::Type::ByteString \- Wrapper for raw strings mapping to BYTEA columns.
.SH "VERSION"
.IX Header "VERSION"
Version 1.2.3
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   PGObject::Type::ByteString\->register();
.Ve
.PP
Now all \s-1BYTEA\s0 columns will be returned as ByteString objects.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a basic wrapper around Perl strings, mapping them to
\&\s-1BYTEA\s0 database columns.
.PP
PGObject::Type::ByteString objects have no traditional properties, however
dereferencing them will yield the raw string they contain.
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.ie n .SS "register([registry => 'default',] [types => $types_arrayref])"
.el .SS "register([registry => 'default',] [types => \f(CW$types_arrayref\fP])"
.IX Subsection "register([registry => 'default',] [types => $types_arrayref])"
By default registers type \s-1PG_BYTEA.\s0
.SS "new"
.IX Subsection "new"
Instantiates and returns a new object, based on the supplied scalar string,
or scalar string reference.
.PP
Dereferencing the returned object will yield the original raw string.
.SS "from_db"
.IX Subsection "from_db"
Returns a new PGObject::Type::ByteString object based on the supplied
scalar string, or scalar string reference.
.SS "to_db"
.IX Subsection "to_db"
Returns the object's binary string value packaged as \s-1PG_BYTEA\s0 type/value
hashref suitable for passing to DBD::Pg.
.SH "AUTHOR"
.IX Header "AUTHOR"
Erik Huelsmann, \f(CW\*(C`<ehuels at gmail.com>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-pgobject\-type\-bytestring at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=PGObject\-Type\-ByteString>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc PGObject::Type::ByteString
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker (report bugs here)
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=PGObject\-Type\-ByteString>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/PGObject\-Type\-ByteString>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/PGObject\-Type\-ByteString>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/PGObject\-Type\-ByteString/>
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2016\-2018 Erik Huelsmann
.PP
This program is released under the following license: \s-1BSD\s0