Symbol

Symbol

public final class Symbol

Inheritance

Codable, Comparable, Contextual, Equatable, Hashable

Nested Type Aliases

ID

public typealias ID = Identifier

Initializers

init(file:relativeTo:)

public init(file url: URL, relativeTo directory: URL) throws

init(from:)

public convenience init(from decoder: Decoder) throws

Properties

path

let path: String

symbols

let symbols: [Symbol]

imports

let imports: [Import]

api

let api: API

context

let context: [Contextual]

declaration

let declaration: String

documentation

let documentation: Documentation?

sourceLocation

let sourceLocation: SourceLocation?

`extension`

var `extension`: Extension? = context.compactMap { $0 as? Extension }.first

conditions

var conditions: [CompilationCondition] = context.compactMap { $0 as? CompilationCondition }

name

var name: String

id

var id: ID = {
        Identifier(pathComponents: context.compactMap {
            ($0 as? Symbol)?.name ?? ($0 as? Extension)?.extendedType
        }, name: name)
    }()

isPublic

var isPublic: Bool

isDocumented

var isDocumented: Bool

Methods

==(lhs:rhs:)

public static func ==(lhs: Symbol, rhs: Symbol) -> Bool

<(lhs:rhs:)

public static func <(lhs: Symbol, rhs: Symbol) -> Bool

hash(into:)

public func hash(into hasher: inout Hasher)

encode(to:)

public func encode(to encoder: Encoder) throws