Data+FileKit.swift 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. //
  2. // Data+FileKit.swift
  3. // FileKit
  4. //
  5. // The MIT License (MIT)
  6. //
  7. // Copyright (c) 2017 Nikolai Vazquez
  8. // Copyright (c) 2017 Marchand Eric
  9. //
  10. // Permission is hereby granted, free of charge, to any person obtaining a copy
  11. // of this software and associated documentation files (the "Software"), to deal
  12. // in the Software without restriction, including without limitation the rights
  13. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14. // copies of the Software, and to permit persons to whom the Software is
  15. // furnished to do so, subject to the following conditions:
  16. //
  17. // The above copyright notice and this permission notice shall be included in
  18. // all copies or substantial portions of the Software.
  19. //
  20. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  26. // THE SOFTWARE.
  27. //
  28. import Foundation
  29. extension Data: ReadableWritable {
  30. /// Returns data read from the given path.
  31. public static func read(from path: Path) throws -> Data {
  32. do {
  33. return try self.init(contentsOf: path.url, options: [])
  34. } catch {
  35. throw FileKitError.readFromFileFail(path: path, error: error)
  36. }
  37. }
  38. /// Returns data read from the given path using Data.ReadingOptions.
  39. public static func read(from path: Path, options: Data.ReadingOptions) throws -> Data {
  40. do {
  41. return try self.init(contentsOf: path.url, options: options)
  42. } catch {
  43. throw FileKitError.readFromFileFail(path: path, error: error)
  44. }
  45. }
  46. /// Writes `self` to a Path.
  47. public func write(to path: Path) throws {
  48. try write(to: path, atomically: true)
  49. }
  50. /// Writes `self` to a path.
  51. ///
  52. /// - Parameter path: The path being written to.
  53. /// - Parameter useAuxiliaryFile: If `true`, the data is written to an
  54. /// auxiliary file that is then renamed to the
  55. /// file. If `false`, the data is written to
  56. /// the file directly.
  57. ///
  58. public func write(to path: Path, atomically useAuxiliaryFile: Bool) throws {
  59. let options: Data.WritingOptions = useAuxiliaryFile ? [.atomic] : []
  60. try self.write(to: path, options: options)
  61. }
  62. /// Writes `self` to a path.
  63. ///
  64. /// - Parameter path: The path being written to.
  65. /// - Parameter options: writing options.
  66. ///
  67. public func write(to path: Path, options: Data.WritingOptions) throws {
  68. do {
  69. try self.write(to: path.url, options: options)
  70. } catch {
  71. throw FileKitError.writeToFileFail(path: path, error: error)
  72. }
  73. }
  74. }