apple/swift-nio-extras
1
0
Fork 0
mirror of https://github.com/apple/swift-nio-extras.git synced 2025-05-14 08:52:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add more docs

Browse Source
This commit is contained in:
Gus Cairo 2025-04-30 17:04:14 +01:00
parent 617d1ac648
commit 222a050c19
1 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Sources/NIOCertificateHotReloading/NIOCertificateHotReloading.swift
View File

@ -94,29 +94,48 @@ public struct TimedCertificateReloader: CertificateReloader {
public static func file(path: String) -> Self { Self(_Backing.file(path: path)) }
/// This certificate/key is available in memory, and will be provided by the given closure.
/// - Parameter provider: A closure providing the bytes for the given certificate or key.
/// - Parameter provider: A closure providing the bytes for the given certificate or key. This closure should return
/// `nil` if a certificate/key isn't currently available for whatever reason.
/// - Returns: A `Location`.
public static func memory(provider: @Sendable @escaping () -> [UInt8]?) -> Self {
Self(_Backing.memory(provider: provider))
}
}
/// A description of a certificate, in terms of its ``Location`` and ``Encoding``.
/// A description of a certificate, in terms of its ``TimedCertificateReloader/Location`` and
/// ``TimedCertificateReloader/Encoding``.
public struct CertificateDescription: Sendable {
public var location: Location
public var format: Encoding
/// The certificate's ``TimedCertificateReloader/Location``.
public var location: Location
/// The certificate's ``TimedCertificateReloader/Encoding``.
public var format: Encoding
/// Initialize a new ``TimedCertificateReloader/CertificateDescription``.
/// - Parameters:
/// - location: A ``TimedCertificateReloader/Location``.
/// - format: A ``TimedCertificateReloader/Encoding``.
public init(location: Location, format: Encoding) {
self.location = location
self.format = format
}
}
/// A description of a private key, in terms of its ``Location`` and ``Encoding``.
/// A description of a private key, in terms of its ``TimedCertificateReloader/Location`` and
/// ``TimedCertificateReloader/Encoding``.
public struct PrivateKeyDescription: Sendable {
/// The key's ``TimedCertificateReloader/Location``.
public var location: Location
/// The key's ``TimedCertificateReloader/Encoding``.
public var format: Encoding
/// Initialize a new ``TimedCertificateReloader/PrivateKeyDescription``.
/// - Parameters:
/// - location: A ``TimedCertificateReloader/Location``.
/// - format: A ``TimedCertificateReloader/Encoding``.
public init(location: Location, format: Encoding) {
self.location = location
self.format = format