STRUCT

HeadersList

Contents

• Properties
  • list
• Methods
  • init(list:)
  • headers(_:)
  • headers(public:private:project:mappingsDir:exclusionRule:compilationCondition:)
  • allHeaders(from:umbrella:private:mappingsDir:compilationCondition:)
  • onlyHeaders(from:umbrella:private:mappingsDir:compilationCondition:)

public struct HeadersList: Codable, Equatable

Properties

list

public var list: [Headers]

Methods

init(list:)

public init(list: [Headers])

headers(_:)

public static func headers(_ list: [Headers]) -> HeadersList

headers(public:private:project:mappingsDir:exclusionRule:compilationCondition:)

public static func headers(
    public: HeaderFileList? = nil,
    private: HeaderFileList? = nil,
    project: HeaderFileList? = nil,
    mappingsDir: FilePath? = nil,
    exclusionRule: Headers.AutomaticExclusionRule = .projectExcludesPrivateAndPublic,
    compilationCondition: PlatformCondition? = nil
) -> HeadersList

allHeaders(from:umbrella:private:mappingsDir:compilationCondition:)

public static func allHeaders(
    from list: HeaderFileList,
    umbrella: FilePath,
    private privateHeaders: HeaderFileList? = nil,
    mappingsDir: FilePath? = nil,
    compilationCondition: PlatformCondition? = nil

) -> HeadersList

Headers from the file list are included as:

• public, if the header is present in the umbrella header
• private, if the header is present in the private list
• project, otherwise
• Parameters:
  • from: File list, which contains public and project headers
  • umbrella: File path to the umbrella header
  • private: File list, which contains private headers

Parameters

Name	Description
from	File list, which contains public and project headers
umbrella	File path to the umbrella header
private	File list, which contains private headers

onlyHeaders(from:umbrella:private:mappingsDir:compilationCondition:)

public static func onlyHeaders(
    from list: HeaderFileList,
    umbrella: FilePath,
    private privateHeaders: HeaderFileList? = nil,
    mappingsDir: FilePath? = nil,
    compilationCondition: PlatformCondition? = nil
) -> HeadersList

Headers from the file list are included as:

• public, if the header is present in the umbrella header
• private, if the header is present in the private list
• not included, otherwise
• Parameters:
  • from: File list, which contains public and project headers
  • umbrella: File path to the umbrella header
  • private: File list, which contains private headers

Parameters

Name	Description
from	File list, which contains public and project headers
umbrella	File path to the umbrella header
private	File list, which contains private headers