CryptoSwift/Sources/CryptoSwift/Updatable.swift

//
//  CryptoSwift
//
//  Copyright (C) 2014-2021 Marcin Krzyżanowski <marcin@krzyzanowskim.com>
//  This software is provided 'as-is', without any express or implied warranty.
//
//  In no event will the authors be held liable for any damages arising from the use of this software.
//
//  Permission is granted to anyone to use this software for any purpose,including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
//
//  - The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation is required.
//  - Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
//  - This notice may not be removed or altered from any source or binary distribution.
//

/// A type that supports incremental updates. For example Digest or Cipher may be updatable
/// and calculate result incerementally.
public protocol Updatable {
  /// Update given bytes in chunks.
  ///
  /// - parameter bytes: Bytes to process.
  /// - parameter isLast: Indicate if given chunk is the last one. No more updates after this call.
  /// - returns: Processed partial result data or empty array.
  mutating func update(withBytes bytes: ArraySlice<UInt8>, isLast: Bool) throws -> Array<UInt8>

  /// Update given bytes in chunks.
  ///
  /// - Parameters:
  ///   - bytes: Bytes to process.
  ///   - isLast: Indicate if given chunk is the last one. No more updates after this call.
  ///   - output: Resulting bytes callback.
  /// - Returns: Processed partial result data or empty array.
  mutating func update(withBytes bytes: ArraySlice<UInt8>, isLast: Bool, output: (_ bytes: Array<UInt8>) -> Void) throws
}

extension Updatable {
  @inlinable
  public mutating func update(withBytes bytes: ArraySlice<UInt8>, isLast: Bool = false, output: (_ bytes: Array<UInt8>) -> Void) throws {
    let processed = try update(withBytes: bytes, isLast: isLast)
    if !processed.isEmpty {
      output(processed)
    }
  }

  @inlinable
  public mutating func update(withBytes bytes: ArraySlice<UInt8>, isLast: Bool = false) throws -> Array<UInt8> {
    try self.update(withBytes: bytes, isLast: isLast)
  }

  @inlinable
  public mutating func update(withBytes bytes: Array<UInt8>, isLast: Bool = false) throws -> Array<UInt8> {
    try self.update(withBytes: bytes.slice, isLast: isLast)
  }

  @inlinable
  public mutating func update(withBytes bytes: Array<UInt8>, isLast: Bool = false, output: (_ bytes: Array<UInt8>) -> Void) throws {
    try self.update(withBytes: bytes.slice, isLast: isLast, output: output)
  }

  /// Finish updates. This may apply padding.
  /// - parameter bytes: Bytes to process
  /// - returns: Processed data.
  @inlinable
  public mutating func finish(withBytes bytes: ArraySlice<UInt8>) throws -> Array<UInt8> {
    try self.update(withBytes: bytes, isLast: true)
  }

  @inlinable
  public mutating func finish(withBytes bytes: Array<UInt8>) throws -> Array<UInt8> {
    try self.finish(withBytes: bytes.slice)
  }

  /// Finish updates. May add padding.
  ///
  /// - Returns: Processed data
  /// - Throws: Error
  @inlinable
  public mutating func finish() throws -> Array<UInt8> {
    try self.update(withBytes: [], isLast: true)
  }

  /// Finish updates. This may apply padding.
  /// - parameter bytes: Bytes to process
  /// - parameter output: Resulting data
  /// - returns: Processed data.
  @inlinable
  public mutating func finish(withBytes bytes: ArraySlice<UInt8>, output: (_ bytes: Array<UInt8>) -> Void) throws {
    let processed = try update(withBytes: bytes, isLast: true)
    if !processed.isEmpty {
      output(processed)
    }
  }

  @inlinable
  public mutating func finish(withBytes bytes: Array<UInt8>, output: (_ bytes: Array<UInt8>) -> Void) throws {
    try self.finish(withBytes: bytes.slice, output: output)
  }

  /// Finish updates. May add padding.
  ///
  /// - Parameter output: Processed data
  /// - Throws: Error
  @inlinable
  public mutating func finish(output: (Array<UInt8>) -> Void) throws {
    try self.finish(withBytes: [], output: output)
  }
}