netwerk/base/src/nsBase64Encoder.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is a base64 encoder stream.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Google Inc.
  18  * Portions created by the Initial Developer are Copyright (C) 2007
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Christian Biesinger <cbiesinger@web.de> (Initial author)
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef NSBASE64ENCODER_H_
  39 #define NSBASE64ENCODER_H_
  40
  41 #include "nsIOutputStream.h"
  42 #include "nsString.h"
  43
  44 /**
  45  * A base64 encoder. Usage: Instantiate class, write to it using
  46  * Write(), then call Finish() to get the base64-encoded data.
  47  */
  48 class nsBase64Encoder : public nsIOutputStream {
  49   public:
  50     nsBase64Encoder() {}
  51
  52     NS_DECL_ISUPPORTS
  53     NS_DECL_NSIOUTPUTSTREAM
  54
  55     nsresult Finish(nsCSubstring& _result);
  56   private:
  57     ~nsBase64Encoder() {}
  58
  59     /// The data written to this stream. nsCString can deal fine with
  60     /// binary data.
  61     nsCString mData;
  62 };
  63
  64 #endif