Function

public enum Function : CustomStringConvertible

An enumeration describing a function.

Show on GitHub

  • A function referred to by its address.

    Declaration

    Swift

    case address(UnsafeMutableRawPointer)
    Show on GitHub

  • A function referred to by its name and (optionally) image.

    If image is nil, it implies that the function may be in any image.

    Declaration

    Swift

    case symbol(_: String, image: URL?)
    Show on GitHub

  • Equivalent to .symbol(name, image: URL(fileURLWithPath: image))

    This initializer deliberately requires a non-nil image parameter, because allowing nil would cause ambiguity between this method and the enum case when passed nil as the second parameter. To use a nil image, invoke symbol(_:String image:URL?) instead, passing URL?.none.

    Declaration

    Swift

    public static func symbol(_ name: String, image: String) -> Function

    Parameters

    name

    The name of the symbol.
    image

    The path to the image in which the symbol is located.

    Return Value

    The described Function.

    Show on GitHub

  • Declaration

    Swift

    public var description: String { get }
    Show on GitHub