Type Aliases

The following type aliases are available globally.

  • A representation of a Feature’s identity in the graph of features defined in the app.

    This type is currently an alias to TopicPath

    Declaration

    Swift

    public typealias FeaturePath = TopicPath
  • The type for parameters that can be decoded and encoded for a URL.

    Declaration

    Swift

    public typealias RouteParameters = [String : String]
  • The protocol for encoding and decoding an input value to and from URL route parameters. Conform your input types to this to to enable execution of actions with your input type when incoming URLs are parsed, as well as creation of URL links to those actions.

    Declaration

    Swift

    public typealias RouteParametersCodable = RouteParametersDecodable & RouteParametersEncodable
  • An unsigned 32-Bit Integer representing a checksum.

    Declaration

    Swift

    public typealias CRC32 = UInt32
  • A custom handler that consumes a Data object containing partial entry data.

    Throws

    Can throw to indicate errors during data consumption.

    Declaration

    Swift

    public typealias Consumer = (_ data: Data) throws -> Void

    Parameters

    data

    A chunk of Data to consume.

  • A custom handler that receives a position and a size that can be used to provide data from an arbitrary source.

    Throws

    Can throw to indicate errors in the data source.

    Declaration

    Swift

    public typealias Provider = (_ position: Int, _ size: Int) throws -> Data

    Parameters

    position

    The current read position.

    size

    The size of the chunk to provide.

    Return Value

    A chunk of Data.