gecko-dev/xpcom/base/nsGZFileWriter.h
Nicholas Nethercote 91655900fc Bug 1295825 (part 3) - Use [must_use] and MOZ_MUST_USE in nsIGZFileWriter.idl. r=froydnj.
--HG--
extra : rebase_source : 7af7a00edf68fe8964c3cade994819288163d198
2016-08-17 17:09:45 +10:00

56 lines
1.2 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsGZFileWriter_h
#define nsGZFileWriter_h
#include "nsIGZFileWriter.h"
#include "zlib.h"
/**
* A simple class for writing .gz files.
*/
class nsGZFileWriter final : public nsIGZFileWriter
{
virtual ~nsGZFileWriter();
public:
enum Operation {
Append,
Create
};
explicit nsGZFileWriter(Operation aMode = Create);
NS_DECL_ISUPPORTS
NS_DECL_NSIGZFILEWRITER
/**
* nsIGZFileWriter exposes two non-virtual overloads of Write(). We
* duplicate them here so that you can call these overloads on a pointer to
* the concrete nsGZFileWriter class.
*/
MOZ_MUST_USE nsresult Write(const char* aStr)
{
return nsIGZFileWriter::Write(aStr);
}
MOZ_MUST_USE nsresult Write(const char* aStr, uint32_t aLen)
{
return nsIGZFileWriter::Write(aStr, aLen);
}
private:
Operation mMode;
bool mInitialized;
bool mFinished;
gzFile mGZFile;
};
#endif