.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "CHI::Driver::RawMemory 3pm"
.TH CHI::Driver::RawMemory 3pm "2021-10-15" "perl v5.32.1" "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"
CHI::Driver::RawMemory \- In\-process memory cache that stores direct references
.SH "VERSION"
.IX Header "VERSION"
version 0.61
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use CHI;
\&
\&    my $hash = {};
\&    my $cache = CHI\->new( driver => \*(AqRawMemory\*(Aq, datastore => $hash );
\&
\&    my $cache = CHI\->new( driver => \*(AqRawMemory\*(Aq, global => 1 );
\&
\&    my $cache = CHI\->new( driver => \*(AqRawMemory\*(Aq, global => 0 );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a subclass of CHI::Driver::Memory that stores
references to data structures directly instead of serializing / deserializing. 
This makes the cache faster at getting and setting complex data structures, but
unlike most drivers, modifications to the original data structure \fIwill\fR
affect the data structure stored in the cache, and vice versa. e.g.
.PP
.Vb 6
\&    my $cache = CHI\->new( driver => \*(AqMemory\*(Aq, global => 1 );
\&    my $lst = [\*(Aqfoo\*(Aq];
\&    $cache\->set(\*(Aqkey\*(Aq => $lst);   # serializes $lst before storing
\&    $cache\->get(\*(Aqkey\*(Aq);   # returns [\*(Aqfoo\*(Aq]
\&    $lst\->[0] = \*(Aqbar\*(Aq;
\&    $cache\->get(\*(Aqkey\*(Aq);   # returns [\*(Aqfoo\*(Aq]
\&
\&    my $cache = CHI\->new( driver => \*(AqRawMemory\*(Aq, global => 1 );
\&    my $lst = [\*(Aqfoo\*(Aq];
\&    $cache\->set(\*(Aqkey\*(Aq => $lst);   # stores $lst directly
\&    $cache\->get(\*(Aqkey\*(Aq);   # returns [\*(Aqfoo\*(Aq]
\&    $lst\->[0] = \*(Aqbar\*(Aq;
\&    $cache\->get(\*(Aqkey\*(Aq);   # returns [\*(Aqbar\*(Aq]!
.Ve
.SH "CONSTRUCTOR OPTIONS"
.IX Header "CONSTRUCTOR OPTIONS"
Same as CHI::Driver::Memory.
.SH "SIZE AWARENESS"
.IX Header "SIZE AWARENESS"
For the purpose of size-awareness, all items count as
size 1 for this driver. (Because data structures are not serialized, there's no
good way to determine their size.)
.PP
.Vb 3
\&    # Keep a maximum of 10 items in cache
\&    #
\&    my $cache = CHI\->new( driver => \*(AqRawMemory\*(Aq, datastore => {}, max_size => 10 );
.Ve
.SH "ACKNOWLEDGMENTS"
.IX Header "ACKNOWLEDGMENTS"
Thanks to Yuval Kogman whose Cache::Ref inspired me to do this.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CHI::Driver::Memory, \s-1CHI\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2021 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.