Thing

public class Thing : Hashable, Comparable

GIR named thing class

  • String representation of the kind of Thing represented by the receiver

    Declaration

    Swift

    public var kind: String { get }
    Show on GitHub

  • type name without namespace/prefix

    Declaration

    Swift

    public let name: String
    Show on GitHub

  • documentation for the Thing

    Declaration

    Swift

    public let comment: String
    Show on GitHub

  • Is this Thing introspectable?

    Declaration

    Swift

    public let introspectable: Bool
    Show on GitHub

  • Alternative to use if deprecated

    Declaration

    Swift

    public let deprecated: String?
    Show on GitHub

  • Is this Thing explicitly marked as deprecated?

    Declaration

    Swift

    public let markedAsDeprecated: Bool
    Show on GitHub

  • Version the receiver is available from

    Declaration

    Swift

    public let version: String?
    Show on GitHub

  • Hashes the essential components of this value by feeding them into the given hasher.

    This method is implemented to conform to the Hashable protocol. Calls hasher.combine(_:) with the name component.

    Declaration

    Swift

    public func hash(into hasher: inout Hasher)

    Parameters

    hasher

    The hasher to use when combining the components of the receiver.
    Show on GitHub

  • Memberwise initialiser

    Declaration

    Swift

    public init(name: String, comment: String, introspectable: Bool = false, deprecated: String? = nil, markedAsDeprecated: Bool = false, version: String? = nil)

    Parameters

    name

    The name of the Thing to initialise
    comment

    Documentation text for the Thing
    introspectable

    Set to true if introspectable
    deprecated

    Documentation on deprecation status if non-nil
    markedAsDeprecated

    Set to true if deprecated
    version

    The version this Thing is first available in
    Show on GitHub

  • XML Element initialser

    Declaration

    Swift

    public init(node: XMLElement, atIndex i: Int, nameAttr: String = "name")

    Parameters

    node

    XMLElement to construct this Thing from
    i

    Index within the siblings of the node
    nameAttr

    Key for the attribute to extract the name property from
    Show on GitHub

  • return a name with reserved Ref or Protocol suffixes escaped

    Declaration

    Swift

    var escapedName: String { get }
    Show on GitHub

  • type name without ‘Private’ suffix (nil if public)

    Declaration

    Swift

    var priv: String? { get }
    Show on GitHub

  • Type name without ‘Class’, ‘Iface’, etc. suffix

    Declaration

    Swift

    var node: String { get }
    Show on GitHub