NSDataFile.swift 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. //
  2. // DataFile.swift
  3. // FileKit
  4. //
  5. // The MIT License (MIT)
  6. //
  7. // Copyright (c) 2015-2017 Nikolai Vazquez
  8. //
  9. // Permission is hereby granted, free of charge, to any person obtaining a copy
  10. // of this software and associated documentation files (the "Software"), to deal
  11. // in the Software without restriction, including without limitation the rights
  12. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. // copies of the Software, and to permit persons to whom the Software is
  14. // furnished to do so, subject to the following conditions:
  15. //
  16. // The above copyright notice and this permission notice shall be included in
  17. // all copies or substantial portions of the Software.
  18. //
  19. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. // THE SOFTWARE.
  26. //
  27. import Foundation
  28. /// A representation of a filesystem data file.
  29. ///
  30. /// The data type is NSData.
  31. public typealias NSDataFile = File<NSData>
  32. extension File where DataType: NSData {
  33. /// Reads the file and returns its data.
  34. /// - Parameter options: A mask that specifies write options
  35. /// described in `NSData.ReadingOptions`.
  36. ///
  37. /// - Throws: `FileKitError.ReadFromFileFail`
  38. /// - Returns: The data read from file.
  39. public func read(_ options: NSData.ReadingOptions) throws -> NSData {
  40. return try NSData.read(from: path, options: options)
  41. }
  42. /// Writes data to the file.
  43. ///
  44. /// - Parameter data: The data to be written to the file.
  45. /// - Parameter options: A mask that specifies write options
  46. /// described in `NSData.WritingOptions`.
  47. ///
  48. /// - Throws: `FileKitError.WriteToFileFail`
  49. ///
  50. public func write(_ data: NSData, options: NSData.WritingOptions) throws {
  51. do {
  52. try data.write(toFile: self.path._safeRawValue, options: options)
  53. } catch {
  54. throw FileKitError.writeToFileFail(path: self.path, error: error)
  55. }
  56. }
  57. }