# binarystring.hxx

Go to the documentation of this file.

    00001 /*-------------------------------------------------------------------------
    00002  *
    00003  *   FILE
    00004  *      pqxx/binarystring.hxx
    00005  *
    00006  *   DESCRIPTION
    00007  *      declarations for bytea (binary string) conversions
    00008  *   DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/binarystring instead.
    00009  *
    00010  * Copyright (c) 2003-2006, Jeroen T. Vermeulen <jtv@xs4all.nl>
    00011  *
    00012  * See COPYING for copyright license.  If you did not receive a file called
    00013  * COPYING with this source code, please notify the distributor of this mistake,
    00014  * or contact the author.
    00015  *
    00016  *-------------------------------------------------------------------------
    00017  */
    00018 #include "pqxx/compiler-public.hxx"
    00019 #include "pqxx/compiler-internal-pre.hxx"
    00020
    00021 #include <string>
    00022
    00023 #include "pqxx/result"
    00024
    00025
    00026 namespace pqxx
    00027 {
    00028
    00030
    00057 class PQXX_LIBEXPORT binarystring : internal::PQAlloc<unsigned char>
    00058 {
    00059   // TODO: Templatize on character type?
    00060 public:
    00061   typedef content_type char_type;
    00062   typedef PGSTD::char_traits<char_type>::char_type value_type;
    00063   typedef size_t size_type;
    00064   typedef long difference_type;
    00065   typedef const value_type &const_reference;
    00066   typedef const value_type *const_pointer;
    00067   typedef const_pointer const_iterator;
    00068
    00069 #ifdef PQXX_HAVE_REVERSE_ITERATOR
    00070   typedef PGSTD::reverse_iterator<const_iterator> const_reverse_iterator;
    00071 #endif
    00072
    00073 private:
    00074   typedef internal::PQAlloc<value_type> super;
    00075
    00076 public:
    00078
    00081   explicit binarystring(const result::field &F);                        //[t62]
    00082
    00084   size_type size() const throw () { return m_size; }                    //[t62]
    00086   size_type length() const throw () { return size(); }                  //[t62]
    00087   bool empty() const throw () { return size()==0; }                     //[t62]
    00088
    00089   const_iterator begin() const throw () { return data(); }              //[t62]
    00090   const_iterator end() const throw () { return data()+m_size; }         //[t62]
    00091
    00092   const_reference front() const throw () { return *begin(); }           //[t62]
    00093   const_reference back() const throw () { return *(data()+m_size-1); }  //[t62]
    00094
    00095 #ifdef PQXX_HAVE_REVERSE_ITERATOR
    00096   const_reverse_iterator rbegin() const                                 //[t62]
    00097         { return const_reverse_iterator(end()); }
    00098   const_reverse_iterator rend() const                                   //[t62]
    00099         { return const_reverse_iterator(begin()); }
    00100 #endif
    00101
    00103   const value_type *data() const throw () {return super::c_ptr();}      //[t62]
    00104
    00105   const_reference operator[](size_type i) const throw ()                //[t62]
    00106         { return data()[i]; }
    00107
    00108   bool operator==(const binarystring &) const throw ();                 //[t62]
    00109   bool operator!=(const binarystring &rhs) const throw ()               //[t62]
    00110         { return !operator==(rhs); }
    00111
    00113   const_reference at(size_type) const;                                  //[t62]
    00114
    00116   void swap(binarystring &);                                            //[t62]
    00117
    00119
    00122   const char *c_ptr() const throw ()                                    //[t62]
    00123   {
    00124     return reinterpret_cast<char *>(super::c_ptr());
    00125   }
    00126
    00128
    00135   const PGSTD::string &str() const;                                     //[t62]
    00136
    00137 private:
    00138   size_type m_size;
    00139   mutable PGSTD::string m_str;
    00140 };
    00141
    00142
    00149
    00150
    00154 PGSTD::string PQXX_LIBEXPORT escape_binary(const PGSTD::string &bin);
    00156
    00160 PGSTD::string PQXX_LIBEXPORT escape_binary(const char bin[]);
    00162
    00166 PGSTD::string PQXX_LIBEXPORT escape_binary(const char bin[], size_t len);
    00168
    00172 PGSTD::string PQXX_LIBEXPORT escape_binary(const unsigned char bin[]);
    00174
    00178 PGSTD::string PQXX_LIBEXPORT escape_binary(const unsigned char bin[], size_t len);
    00179
    00185 }
    00186
    00187 #include "pqxx/compiler-internal-post.hxx"