0080-failable-numeric-initializers.md

Failable Numeric Conversion Initializers

• Proposal: SE-0080
• Author: Matthew Johnson
• Status: Accepted with Revisions for Swift 3 (Rationale, Bug)
• Review manager: Chris Lattner

Introduction

Swift numeric types all currently have a family of conversion initializers. In many use cases they leave a lot to be desired. Initializing an integer type with a floating point value will truncate any fractional portion of the number. Initializing with an out-of-range value traps.

This proposal is to add a new family of conversion initializers to all numeric types that either complete successfully without loss of information or return nil.

Swift-evolution thread: Proposal: failable numeric conversion initializers

Motivation

It is extremely common to receive loosely typed data from an external source such as json. This data usually has an expected schema with more precise types. When initializing model objects with such data runtime conversion must be performed. It is extremely desirable to be able to do so in a safe and recoverable manner. The best way to accomplish that is to support failable numeric conversions in the standard library.

Proposed solution

Add a new family of numeric conversion initializers with the following signatures to all numeric types:

//  Conversions from all integer types.
init?(exactly value: Int8)
init?(exactly value: Int16)
init?(exactly value: Int32)
init?(exactly value: Int64)
init?(exactly value: Int)
init?(exactly value: UInt8)
init?(exactly value: UInt16)
init?(exactly value: UInt32)
init?(exactly value: UInt64)
init?(exactly value: UInt)

//  Conversions from all floating-point types.
init?(exactly value: Float)
init?(exactly value: Double)
#if arch(i386) || arch(x86_64)
init?(exactly value: Float80)
#endif

Detailed design

A small tolerance for floating point precision may or may not be desirable. This is an open question that should be resolved during review.

Impact on existing code

This is a strictly additive change and will not impact existing code.

Alternatives considered

An earlier version of this proposal used throwing initializer rather than failable initializers. This was changed based on community feedback.

//  Conversions from all integer types.
init(exact value: Int8) throws
init(exact value: Int16) throws
init(exact value: Int32) throws
init(exact value: Int64) throws
init(exact value: Int) throws
init(exact value: UInt8) throws
init(exact value: UInt16) throws
init(exact value: UInt32) throws
init(exact value: UInt64) throws
init(exact value: UInt) throws

//  Conversions from all floating-point types.
init(exact value: Float) throws
init(exact value: Double) throws
#if arch(i386) || arch(x86_64)
init(exact value: Float80) throws
#endif