Files
SWCompression/Sources/Common/Container/Container.swift
T
Timofey Solomko 05268bd44e [docs] Add "missing" docs for Container.Entry and and ContainerEntry.Info
Apparently, something changed in Swift 4.1 and sourcekitten/jazzy now detects associated types and produces documentation for them.
2018-04-13 18:53:58 +03:00

21 lines
600 B
Swift

// Copyright (c) 2018 Timofey Solomko
// Licensed under MIT License
//
// See LICENSE for license information
import Foundation
/// A type that represents a container with files, directories and/or other data.
public protocol Container {
/// A type that represents an entry from this container.
associatedtype Entry: ContainerEntry
/// Retrieve all container entries with their data.
static func open(container: Data) throws -> [Entry]
/// Retrieve information about all container entries (without their data).
static func info(container: Data) throws -> [Entry.Info]
}