Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

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-2004, 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/libcompiler.h"
00019 
00020 #include <string>
00021 
00022 #include "pqxx/result"
00023 
00024 
00025 namespace pqxx
00026 {
00027 
00029 
00041 class PQXX_LIBEXPORT binarystring : internal::PQAlloc<unsigned char>
00042 {
00043   // TODO: Templatize on character type?
00044 public:
00045   typedef content_type char_type;
00046   typedef PGSTD::char_traits<char_type>::char_type value_type;
00047   typedef size_t size_type;
00048   typedef long difference_type;
00049   typedef const value_type &const_reference;
00050   typedef const value_type *const_pointer;
00051   typedef const_pointer const_iterator;
00052 
00053 #ifdef PQXX_HAVE_REVERSE_ITERATOR
00054   typedef PGSTD::reverse_iterator<const_iterator> const_reverse_iterator;
00055 #endif
00056 
00057 private:
00058   typedef internal::PQAlloc<value_type> super;
00059 
00060 public:
00062 
00065   explicit binarystring(const result::field &F);                        //[t62]
00066 
00068   size_type size() const throw () { return m_size; }                    //[t62]
00069   size_type length() const throw () { return size(); }                  //[t62]
00070   bool empty() const throw () { return size()==0; }                     //[t62]
00071 
00072   const_iterator begin() const throw () { return data(); }              //[t62]
00073   const_iterator end() const throw () { return data()+m_size; }         //[t62]
00074 
00075   const_reference front() const throw () { return *begin(); }           //[t62]
00076   const_reference back() const throw () { return *(data()+m_size-1); }  //[t62]
00077 
00078 #ifdef PQXX_HAVE_REVERSE_ITERATOR
00079   const_reverse_iterator rbegin() const                                 //[t62]
00080         { return const_reverse_iterator(end()); }
00081   const_reverse_iterator rend() const                                   //[t62]
00082         { return const_reverse_iterator(begin()); }
00083 #endif
00084 
00086   const value_type *data() const throw () {return super::c_ptr();}      //[t62]
00087 
00088   const_reference operator[](size_type i) const throw ()                //[t62]
00089         { return data()[i]; }
00090 
00091   bool operator==(const binarystring &) const throw ();                 //[t62]
00092   bool operator!=(const binarystring &rhs) const throw ()               //[t62]
00093         { return !operator==(rhs); }
00094 
00096   const_reference at(size_type) const;                                  //[t62]
00097 
00098   void swap(binarystring &);                                            //[t62]
00099 
00101 
00104   const char *c_ptr() const throw ()                                    //[t62]
00105   {
00106     return reinterpret_cast<char *>(super::c_ptr());
00107   }
00108 
00110 
00112   const PGSTD::string &str() const;                                     //[t62]
00113 
00114 private:
00115   size_type m_size;
00116   mutable PGSTD::string m_str;
00117 };
00118 
00119 
00121 PGSTD::string PQXX_LIBEXPORT escape_binary(const PGSTD::string &bin);
00123 PGSTD::string PQXX_LIBEXPORT escape_binary(const char bin[]);
00125 PGSTD::string PQXX_LIBEXPORT escape_binary(const char bin[], size_t len);
00127 PGSTD::string PQXX_LIBEXPORT escape_binary(const unsigned char bin[]);
00129 PGSTD::string PQXX_LIBEXPORT escape_binary(const unsigned char bin[], size_t len);
00130 
00131 
00132 }
00133 

Generated on Mon Nov 1 19:13:35 2004 for libpqxx by  doxygen 1.3.9.1