Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daisuke-t-jp/xxhash-swift

xxHash framework in Swift.
https://github.com/daisuke-t-jp/xxhash-swift

carthage cocoapods digest hash hash-functions ios linux macos swift swift-package-manager tvos xxhash

Last synced: 3 months ago
JSON representation

xxHash framework in Swift.

Host: GitHub
URL: https://github.com/daisuke-t-jp/xxhash-swift
Owner: daisuke-t-jp
License: mit
Created: 2019-02-12T11:36:36.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2021-12-17T15:01:30.000Z (about 3 years ago)
Last Synced: 2024-10-20T00:52:53.726Z (3 months ago)
Topics: carthage, cocoapods, digest, hash, hash-functions, ios, linux, macos, swift, swift-package-manager, tvos, xxhash
Language: Swift
Homepage: https://cocoapods.org/pods/xxHash-Swift
Size: 590 KB
Stars: 29
Watchers: 4
Forks: 6
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

------

![Platform](https://img.shields.io/badge/Platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20Linux-blue.svg)

[![Language Swift%205.0](https://img.shields.io/badge/Language-Swift%205.0-orange.svg)](https://developer.apple.com/swift)

[![CocoaPods](https://img.shields.io/cocoapods/v/xxHash-Swift.svg)](https://cocoapods.org/pods/xxHash-Swift)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-green.svg)](https://github.com/Carthage/Carthage)

[![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-green.svg)](https://github.com/apple/swift-package-manager)

![Build Status](https://github.com/daisuke-t-jp/xxHash-Swift/actions/workflows/ci.yml/badge.svg)

# Introduction

[**xxHash**](https://cyan4973.github.io/xxHash/) framework in Swift.  

A framework includes XXH32/XXH64/XXH3-64/XXH3-128 functions.  

  

Original xxHash algorithm created by [Yann Collet](https://github.com/Cyan4973).

# Requirements

- Platforms

  - iOS 10.0+

  - macOS 10.12+

  - tvOS 12.0+

  - Linux

- Swift 5.0

# Installation

## Carthage

`github "daisuke-t-jp/xxHash-Swift"`

## CocoaPods

```

use_frameworks!

target 'target' do

pod 'xxHash-Swift'

end

```

# Usage

## Import framework

```swift

import xxHash_Swift

```

## XXH32

### Generate digest(One-shot)

```swift

let digest = XXH32.digest("123456789ABCDEF")

// digest -> 0x576e3cf9

// Using seed.

let digest = XXH32.digest("123456789ABCDEF", seed: 0x7fffffff)

// digest -> 0xa7f06f9d

```

### Generate digest(Streaming)

```swift

// Create xxHash instance

let xxh = XXH32() // if using seed, e.g. "XXH32(0x7fffffff)"

// Get data from file

let bundle = Bundle(for: type(of: self))

let path = bundle.path(forResource: "alice29", ofType: "txt")!

let data = NSData(contentsOfFile: path)! as Data

let bufSize = 1024

var index = 0

repeat {

    var lastIndex = index + bufSize

    if lastIndex > data.count {

        lastIndex = index + data.count - index

    }

    let data2 = data[index..= data.count {

        break

    }

} while(true)

let digest = xxh.digest()

// digest -> 0xafc8e0c2

```

## XXH64

### Generate digest(One-shot)

```swift

let digest = XXH64.digest("123456789ABCDEF")

// digest -> 0xa66df83f00e9202d

// Using seed.

let digest = XXH64.digest("123456789ABCDEF", seed: 0x000000007fffffff)

// digest -> 0xe8d84202a16e482f

```

### Generate digest(Streaming)

```swift

// Create xxHash instance

let xxh = XXH64() // if using seed, e.g. "XXH64(0x000000007fffffff)"

// Get data from file

let bundle = Bundle(for: type(of: self))

let path = bundle.path(forResource: "alice29", ofType: "txt")!

let data = NSData(contentsOfFile: path)! as Data

let bufSize = 1024

var index = 0

repeat {

    var lastIndex = index + bufSize

    if lastIndex > data.count {

        lastIndex = index + data.count - index

    }

    let data2 = data[index..= data.count {

        break

    }

} while(true)

let digest = xxh.digest()

// digest -> 0x843c2c4ccfbfb749

```

## XXH3-64

### Generate digest(One-shot)

```swift

let digest = XXH3.digest64("123456789ABCDEF")

// digest -> 0xfb28db77f56706e8

// Using seed.

let digest = XXH3.digest64("123456789ABCDEF", seed: 0x000000007fffffff)

// digest -> 0xced1ef1da8aa95ae

```

## XXH3-128

### Generate digest(One-shot)

```swift

let digest = XXH3.digest128("123456789ABCDEF")

// digest[0] -> 0x208cfe2ef00d2aaa

// digest[1] -> 0x9b72015eec4abbf3

// Using seed.

let digest = XXH3.digest128("123456789ABCDEF", seed: 0x000000007fffffff)

// digest[0] -> 0x50554db504518e64

// digest[1] -> 0xc8fb00b18f99658c

```

# Demo

There are demos.

- [iOS](https://github.com/daisuke-t-jp/xxHash-Swift/tree/master/demo/xxHashDemo-iOS) 

- [macOS](https://github.com/daisuke-t-jp/xxHash-Swift/tree/master/demo/xxHashDemo-macOS) 

- [tvOS](https://github.com/daisuke-t-jp/xxHash-Swift/tree/master/demo/xxHashDemo-tvOS)