javier
b14a9fa816
This PR contains the work done to improve the documentation efforts in the package, aiming at improving the documentation of the source code as well as the OpenAPI specification document. In addition, a breaking bug has been fixed. Reviewed-on: #16 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
65 lines
1.8 KiB
Swift
65 lines
1.8 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the DiscogsService open source project
|
|
//
|
|
// Copyright (c) 2026 Röck+Cöde VoF. and the DiscogsService project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of DiscogsService project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
/// A validation rule type that checks whether an input is nil or not.
|
|
struct NotNilValidationRule: InputValidationRule {
|
|
|
|
// MARK: Functions
|
|
|
|
#if swift(>=6.0)
|
|
func validate(_ input: String?) throws(InputValidationError) -> Bool {
|
|
try validate(input: input)
|
|
}
|
|
#else
|
|
func validate(_ input: String?) throws -> Bool {
|
|
try validate(input: input)
|
|
}
|
|
#endif
|
|
|
|
}
|
|
|
|
// MARK: - Definitions
|
|
|
|
extension InputValidationRule where Self == NotNilValidationRule {
|
|
|
|
// MARK: Constants
|
|
|
|
/// A validation rule that checks whether an input is nil or not.
|
|
static var notNil: Self { .init() }
|
|
|
|
}
|
|
|
|
// MARK: - Helpers
|
|
|
|
private extension NotNilValidationRule {
|
|
|
|
// MARK: Functions
|
|
|
|
/// Validates a given input.
|
|
///
|
|
/// > note: This helper function would not be necessary when support for *Swift 5.10* is discontinued.
|
|
///
|
|
/// - Parameter input: An input to be validated.
|
|
/// - Returns: A flag that indicates whether a given input has been validated or not.
|
|
/// - Throws: An error of type ``InputValidationError`` in case the validation failed.
|
|
func validate(input: String?) throws -> Bool {
|
|
guard input != nil else {
|
|
throw InputValidationError.inputIsNil
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
}
|