NAME

       Compress::compressString - Compress a string.

SYNOPSIS

       String compressString( String instr )

ARGUMENTS

       instr The String to compress

DESCRIPTION

       Compress  a  string  using  zlib and returned a base64-encoded compressed string. If compression fails, a
       Compress.CompressionFailed (3kaya) Exception will be thrown. Note that because base64-encoding  increases
       the  space  required,  if  the  compression factor is small, the compressed string may be larger than the
       original! In this case converting the string to Binary form and using compressBinary may be better.

AUTHORS

       Kaya standard  library  by  Edwin  Brady,  Chris  Morris  and  others  (kaya@kayalang.org).  For  further
       information see http://kayalang.org/

LICENSE

       The  Kaya  standard library is free software; you can redistribute it and/or modify it under the terms of
       the GNU Lesser General Public License (version 2.1 or  any  later  version)  as  published  by  the  Free
       Software Foundation.

RELATED

       Compress.compressBinary (3kaya)
       Compress.uncompressString (3kaya)

Kaya                                                July 2013                     Compress.compressString(3kaya)