NSData+KSGZip.h 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. //
  2. // NSData+GZip.h
  3. //
  4. // Created by Karl Stenerud on 2012-02-19.
  5. //
  6. // Copyright (c) 2012 Karl Stenerud. All rights reserved.
  7. //
  8. // Permission is hereby granted, free of charge, to any person obtaining a copy
  9. // of this software and associated documentation files (the "Software"), to deal
  10. // in the Software without restriction, including without limitation the rights
  11. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. // copies of the Software, and to permit persons to whom the Software is
  13. // furnished to do so, subject to the following conditions:
  14. //
  15. // The above copyright notice and this permission notice shall remain in place
  16. // in this source code.
  17. //
  18. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. // THE SOFTWARE.
  25. //
  26. #import <Foundation/Foundation.h>
  27. /**
  28. * GNU zip/unzip support for NSData.
  29. */
  30. @interface NSData (KSGZip)
  31. /**
  32. * Gzip the data in this object (no header).
  33. *
  34. * @param compressionLevel The GZip compression level to use:
  35. * 0 = no compression.
  36. * 1 = best speed.
  37. * 9 = best compression.
  38. * -1 = default.
  39. *
  40. * @param error (optional) Set to any error that occurs, or nil if no error.
  41. * Pass nil to ignore.
  42. *
  43. * @return A new NSData with the gzipped contents of this object.
  44. */
  45. - (NSData*) gzippedWithCompressionLevel:(int) compressionLevel
  46. error:(NSError**) error;
  47. /**
  48. * Gunzip the data in this object (no header).
  49. *
  50. * @param error (optional) Set to any error that occurs, or nil if no error.
  51. * Pass nil to ignore.
  52. *
  53. * @return A new NSData with the gunzipped contents of this object.
  54. */
  55. - (NSData*) gunzippedWithError:(NSError**) error;
  56. @end