<div dir="ltr">That sure looks like a nice addition. 👍<div><br></div><div>I tried to keep the proposal as small as possible, as it already looks much more complicated than it is.</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Mar 13, 2017 at 6:25 PM, Haravikk <span dir="ltr"><<a href="mailto:swift-evolution@haravikk.me" target="_blank">swift-evolution@haravikk.me</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div style="word-wrap:break-word"><div>I really like the proposal!</div><div><br></div><div>Only thing I'm wondering is whether a convenience function on Hasher might be nice to have, like so:</div><div><br></div><div><font face="Monaco"><span class="m_-2407530288242542364Apple-tab-span" style="white-space:pre-wrap"> </span>extension Hasher {</font></div><div><font face="Monaco"><span class="m_-2407530288242542364Apple-tab-span" style="white-space:pre-wrap"> </span>mutating func hash<H:Hashable>(_ hashable:H) -> Int {</font></div><div><font face="Monaco"><span class="m_-2407530288242542364Apple-tab-span" style="white-space:pre-wrap"> </span>hashable.hash(self)</font></div><div><font face="Monaco"><span class="m_-2407530288242542364Apple-tab-span" style="white-space:pre-wrap"> </span>return self.finish()</font></div><div><font face="Monaco"><span class="m_-2407530288242542364Apple-tab-span" style="white-space:pre-wrap"> </span>}</font></div><div><font face="Monaco"><span class="m_-2407530288242542364Apple-tab-span" style="white-space:pre-wrap"> </span>}</font></div><div><br></div><div>This just feels like it would be easier for the most common case where you just need to hash a single value right away, as you'd just do:</div><div><br></div><div><font face="Monaco"><span class="m_-2407530288242542364Apple-tab-span" style="white-space:pre-wrap"> </span>let hashValue = hasher.hash(foo)</font></div><div><br></div><div>While leaving the inout style available for when you do need to combine multiple values together or otherwise feed in data gradually. This way we're not losing as much of the convenience of the .hashValue that's being deprecated. On that note, should Hashable be updated to do something like the above as well, so it still immediately returns a value from a default hasher?</div><div><br></div><div>Anyway, definitely in favour of this change, as you're right; .hashValue is a hard thing to do right, and is often an after-thought, which can make it of limited usefulness to types that depend upon it!</div><br><div><blockquote type="cite"><div><div class="h5"><div>On 13 Mar 2017, at 15:38, Vincent Esche via swift-evolution <<a href="mailto:swift-evolution@swift.org" target="_blank">swift-evolution@swift.org</a>> wrote:</div><br class="m_-2407530288242542364Apple-interchange-newline"></div></div><div><div><div class="h5"><div dir="ltr"><div>Hi there,</div><div><br></div><div>I've written up a proposal for an overhaul/replacement of the Hashable protocol and would love to hear your feedback on it!</div><div><br></div><a href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25" target="_blank">Rendered</a> | <a href="https://blog.definiteloops.com/ha-r-sh-visitors-8c0c3686a46f" target="_blank">Blog Post</a><div><br></div><div>Cheers,</div><div>Vincent</div><div><br></div><div>Ps: I'd like to thank David Hart (@hartbit) for his great editorial feedback on this proposal. 👍</div><div><br></div><div><h1 style="box-sizing:border-box;margin:0px 0px 16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol"">HashVisitable</h1><ul style="box-sizing:border-box;padding-left:2em;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px"><li style="box-sizing:border-box">Proposal: <a href="https://gist.github.com/regexident/NNNN-filename.md" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none" target="_blank">SE-NNNN</a></li><li style="box-sizing:border-box;margin-top:0.25em">Authors: <a href="https://github.com/regexident" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none" target="_blank">Vincent Esche</a></li><li style="box-sizing:border-box;margin-top:0.25em">Review Manager: TBD</li><li style="box-sizing:border-box;margin-top:0.25em">Status: <span style="box-sizing:border-box;font-weight:600">Awaiting review</span></li></ul><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-introduction" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#introduction" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Introduction</h2><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Replace the <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hashable</code> protocol by two new procotols (<code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hasher</code> and <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">HashVisitable</code>) to improve safety, versatility and learnability.</p><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-motivation" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#motivation" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Motivation</h2><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Implementing <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hashable</code> is difficult and the consequences if not done well have dire performance and safety repercussions.</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">The documentation of <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hashable</code> lists a <a href="https://developer.apple.com/reference/swift/hashable" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none" target="_blank">sample implementation</a> of <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">var hashValue</code>:</p><pre style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;margin-top:0px;margin-bottom:16px;font-stretch:normal;line-height:1.45;word-wrap:normal;padding:16px;overflow:auto;background-color:rgb(246,248,250);border-radius:3px;color:rgb(36,41,46)"><code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0px;margin:0px;background-image:initial;background-position:initial;background-size:initial;background-repeat:initial;background-origin:initial;background-clip:initial;background-color:transparent;border-radius:3px;word-break:normal;border:0px;display:inline;overflow:visible;line-height:inherit;word-wrap:normal">/// A point in an x-y coordinate system.
struct GridPoint {
var x: Int
var y: Int
}
extension GridPoint: Hashable {
var hashValue: Int {
return x.hashValue ^ y.hashValue
}
static func == (lhs: GridPoint, rhs: GridPoint) -> Bool {
return lhs.x == rhs.x && lhs.y == rhs.y
}
}
</code></pre><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Calculating the hashes of all <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">GridPoints</code> (given the above implementation) on a <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">1000 × 1000</code> grid …</p><pre style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;margin-top:0px;margin-bottom:16px;font-stretch:normal;line-height:1.45;word-wrap:normal;padding:16px;overflow:auto;background-color:rgb(246,248,250);border-radius:3px;color:rgb(36,41,46)"><code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0px;margin:0px;background-image:initial;background-position:initial;background-size:initial;background-repeat:initial;background-origin:initial;background-clip:initial;background-color:transparent;border-radius:3px;word-break:normal;border:0px;display:inline;overflow:visible;line-height:inherit;word-wrap:normal">let (width, height) = (1000, 1000)
let total = width * height
var hashes = Set<Int>()
for x in 0..<width {
for y in 0..<height {
hashes.insert(GridPoint(x: x, y: y).hashValue)
}
}
print("\(hashes.count) unique hashes out of a total of \(total).")
</code></pre><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">… results in just <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">1024</code> unique hash values for <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">1_000_000</code> unique values.</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">In other words: The recommended implementation causes 99.9% of values to trigger a hash collision.</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Out of those <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">1_000_000</code> values the median collision count was <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">976</code> with min and max being <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">976</code> and <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">1000</code>respectively<wbr>.</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">The collision rate will have negative impact in algorithms which heavily use <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">hashValue</code> like the ones in <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Dictionary</code>and <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Set</code>. Furthermore, it increases the vulnerability to <a href="https://arstechnica.com/business/2011/12/huge-portions-of-web-vulnerable-to-hashing-denial-of-service-attack/" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none" target="_blank">DDOS attacks when exposed to the web</a>.</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">If even the official Swift documentation gets the implementation of <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">hashValue</code> wrong, then who is to expect the average Swift programmer to do any better?</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">In contrast, running the same snippet using <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">HashVisitable</code> and the semi-secure <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Fnv1aHash</code> (see below) results in zero collisions!</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Finally, the design of the <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hashable</code> protocol forces the use of one implementation without the possibility of switching between multiple hashing algorithms.</p><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-proposed-solution" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#proposed-solution" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Proposed solution</h2><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Instead of coupling the hashing algorithm with each and every Swift type, we should provide a hashing API based on the visitor-pattern. By freeing application developers from the burden of having to implement hashing algorithms, the Standard Library can provide default ones which fulfill collision, performance and security goals. Furthermore, it would allow developers to swap to different algorithms based on the use case.</p><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-detailed-design" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#detailed-design" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Detailed design</h2><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">The proposal deprecates the <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hashable</code> protocol and introduces the following two:</p><div class="m_-2407530288242542364gmail-highlight m_-2407530288242542364gmail-highlight-source-swift" style="box-sizing:border-box;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px"><pre style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;margin-top:0px;margin-bottom:0px;font-stretch:normal;line-height:1.45;word-wrap:normal;padding:16px;overflow:auto;background-color:rgb(246,248,250);border-radius:3px;word-break:normal"><span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">protocol</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">Hasher</span> {
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">mutating</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">func</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">finish</span>() <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">-></span> <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">Int</span>
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">mutating</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">func</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">write</span>(<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)"><span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">bytes</span></span>: UnsafeRawBufferPointer)
}
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">protocol</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">HashVisitable</span> {
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">func</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">hash</span><<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">H</span>: <span class="m_-2407530288242542364gmail-pl-e" style="box-sizing:border-box;color:rgb(121,93,163)">Hasher</span>>(<span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">_</span> <span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">hasher</span>: <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">inout</span> H)
}</pre></div><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px"><code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hasher</code> is the protocol which represents a hashing algorithm, and <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">HashVisitable</code> replaces <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Has<wbr>hable</code>. For types entirely represented by their memory layout, the following protocol would provide a default implementation:</p><pre style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;margin-top:0px;margin-bottom:16px;font-stretch:normal;line-height:1.45;word-wrap:normal;padding:16px;overflow:auto;background-color:rgb(246,248,250);border-radius:3px;color:rgb(36,41,46)"><code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0px;margin:0px;background-image:initial;background-position:initial;background-size:initial;background-repeat:initial;background-origin:initial;background-clip:initial;background-color:transparent;border-radius:3px;word-break:normal;border:0px;display:inline;overflow:visible;line-height:inherit;word-wrap:normal">protocol ContiguouslyHashable: HashVisitable {}
extension ContiguouslyHashable {
func hash<H: Hasher>(_ hasher: inout H) {
var mutableSelf = self
try! Swift.withUnsafeBytes(of: &mutableSelf) {
hasher.write(bytes: $0)
}
}
}
extension Bool : ContiguouslyHashable {}
extension UInt8 : ContiguouslyHashable {}
extension UInt16 : ContiguouslyHashable {}
extension UInt32 : ContiguouslyHashable {}
extension UInt64 : ContiguouslyHashable {}
extension UInt : ContiguouslyHashable {}
extension Int8 : ContiguouslyHashable {}
extension Int16 : ContiguouslyHashable {}
extension Int32 : ContiguouslyHashable {}
extension Int64 : ContiguouslyHashable {}
extension Int : ContiguouslyHashable {}
</code></pre><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">The Standard-Library would then provide a set of hashing implementations specific to each purpose. A possible choice for hashing algorithms would be the reasonably fast <a href="https://en.wikipedia.org/wiki/SipHash" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none" target="_blank">SipHash-2-4</a>, and the reasonably secure <a href="https://en.wikipedia.org/wiki/SipHash" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none" target="_blank">SipHash-4-8</a>.</p><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">FNV-1A is another popular semi-secure but blazingly fast hash algorithm, which – for the sake of demonstration – could be implemented as follows:</p><div class="m_-2407530288242542364gmail-highlight m_-2407530288242542364gmail-highlight-source-swift" style="box-sizing:border-box;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px"><pre style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;margin-top:0px;margin-bottom:0px;font-stretch:normal;line-height:1.45;word-wrap:normal;padding:16px;overflow:auto;background-color:rgb(246,248,250);border-radius:3px;word-break:normal"><span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">struct</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">Fnv1aHash</span> {
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">fileprivate</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">var</span> state<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">:</span> <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">UInt</span>
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">init</span>(<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)"><span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">seed</span></span>: <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">UInt</span>) {
<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">self</span>.<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">state</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">=</span> seed <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">&+</span> <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">14695981039346656037</span>
}
}
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">extension</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">Fnv1aHash</span>: <span class="m_-2407530288242542364gmail-pl-e" style="box-sizing:border-box;color:rgb(121,93,163)">Hasher </span>{
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">mutating</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">func</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">write</span>(<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)"><span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">bytes</span></span>: UnsafeRawBufferPointer) {
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">for</span> byte <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">in</span> bytes {
<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">self</span>.<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">state</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">=</span> (<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">self</span>.<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">state</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">^</span> <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">UInt</span>(byte)) <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">&*</span> <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">1099511628211</span>
}
}
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">mutating</span> <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">func</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">finish</span>() <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">-></span> <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">Int</span> {
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">return</span> <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">unsafeBitCast</span>(<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">self</span>.<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">state</span>, <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">to</span>: <span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">Int</span>.<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">self</span>)
}
}</pre></div><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Coming back to the sample code present in the <code style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;padding:0.2em 0px;margin:0px;background-color:rgba(27,31,35,0.0470588);border-radius:3px">Hashable</code> documentation, the new implementation would look like:</p><div class="m_-2407530288242542364gmail-highlight m_-2407530288242542364gmail-highlight-source-swift" style="box-sizing:border-box;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px"><pre style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;margin-top:0px;margin-bottom:0px;font-stretch:normal;line-height:1.45;word-wrap:normal;padding:16px;overflow:auto;background-color:rgb(246,248,250);border-radius:3px;word-break:normal"><span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">extension</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">GridPoint</span>: <span class="m_-2407530288242542364gmail-pl-e" style="box-sizing:border-box;color:rgb(121,93,163)">HashVisitable </span>{
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">func</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">hash</span><<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">H</span>: <span class="m_-2407530288242542364gmail-pl-e" style="box-sizing:border-box;color:rgb(121,93,163)">Hasher</span>>(<span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">_</span> <span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">hasher</span>: <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">inout</span> H) {
<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">self</span>.<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">x</span>.<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">hash</span>(<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">&</span>hasher)
<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">self</span>.<span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">y</span>.<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">hash</span>(<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">&</span>hasher)
}
}</pre></div><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-source-compatibility" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#source-compatibility" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Source compatibility</h2><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">Making use of "<a href="https://github.com/apple/swift-evolution/blob/d33c129f0920af0404f42219db56981411b20e76/proposals/0143-conditional-conformances.md#extending-protocols-to-conform-to-protocols" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none" target="_blank">extending protocols to conform to protocols</a>":</p><div class="m_-2407530288242542364gmail-highlight m_-2407530288242542364gmail-highlight-source-swift" style="box-sizing:border-box;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px"><pre style="box-sizing:border-box;font-family:sfmono-regular,consolas,"liberation mono",menlo,courier,monospace;font-size:13.6px;margin-top:0px;margin-bottom:0px;font-stretch:normal;line-height:1.45;word-wrap:normal;padding:16px;overflow:auto;background-color:rgb(246,248,250);border-radius:3px;word-break:normal"><span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">extension</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)"><span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">Hashable</span></span>: <span class="m_-2407530288242542364gmail-pl-e" style="box-sizing:border-box;color:rgb(121,93,163)">HashVisitable </span>{
<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">func</span> <span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">hash</span><<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">H</span>: <span class="m_-2407530288242542364gmail-pl-e" style="box-sizing:border-box;color:rgb(121,93,163)">Hasher</span>>(<span class="m_-2407530288242542364gmail-pl-en" style="box-sizing:border-box;color:rgb(121,93,163)">_</span> <span class="m_-2407530288242542364gmail-pl-smi" style="box-sizing:border-box;color:rgb(51,51,51)">hasher</span>: <span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">inout</span> H) {
<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">self</span>.<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">hashValue</span>.<span class="m_-2407530288242542364gmail-pl-c1" style="box-sizing:border-box;color:rgb(0,134,179)">hash</span>(<span class="m_-2407530288242542364gmail-pl-k" style="box-sizing:border-box;color:rgb(167,29,93)">&</span>hasher)
}
}</pre></div><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-effect-on-abi-stability" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#effect-on-abi-stability" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Effect on ABI stability</h2><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">n/a</p><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-effect-on-api-resilience" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#effect-on-api-resilience" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Effect on API resilience</h2><p style="box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol";font-size:16px">This feature should be possible to add/remove without breaking ABI.</p><h2 style="box-sizing:border-box;margin-top:24px;margin-bottom:16px;line-height:1.25;padding-bottom:0.3em;border-bottom:1px solid rgb(234,236,239);color:rgb(36,41,46);font-family:-apple-system,system-ui,"segoe ui",helvetica,arial,sans-serif,"apple color emoji","segoe ui emoji","segoe ui symbol""><a id="m_-2407530288242542364gmail-user-content-alternatives-considered" class="m_-2407530288242542364gmail-anchor" href="https://gist.github.com/regexident/1b8e84974da2243e5199e760508d2d25#alternatives-considered" style="box-sizing:border-box;background-color:transparent;color:rgb(3,102,214);text-decoration:none;float:left;padding-right:4px;line-height:1" target="_blank"></a>Alternatives considered</h2><div style="box-sizing:border-box;margin-top:0px;color:rgb(36,41,46);font-family:-apple-system,system-ui,'segoe ui',helvetica,arial,sans-serif,'apple color emoji','segoe ui emoji','segoe ui symbol';font-size:16px;margin-bottom:0px">n/a</div></div></div></div></div>
______________________________<wbr>_________________<br>swift-evolution mailing list<br><a href="mailto:swift-evolution@swift.org" target="_blank">swift-evolution@swift.org</a><br><a href="https://lists.swift.org/mailman/listinfo/swift-evolution" target="_blank">https://lists.swift.org/<wbr>mailman/listinfo/swift-<wbr>evolution</a><br></div></blockquote></div><br></div></blockquote></div><br></div>