// swift-tools-version: 5.7
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "YourPackage",
    products: [
        .library(name: "YourPackage", targets: ["YourPackage"]),
    ],
    dependencies: [
        .package(url: "https://github.com/panicfrog/Filters.git", from: "0.0.2"),
    ],
    targets: [
        .target(
            name: "YourPackage",
            dependencies: ["Filter"]),
    ]
)

// create bloom filter with `BloomFilterBuilder`
let bloom = BloomFilterBuilder.default
        .with(maxElements: max)   // the maximum number of elements expected to be added
        .with(hasher: Xxhasher()) // default is Murmurhash3_x86_32
        .with(safety: true)       // thread safety
        .build()
// add item to filter
bloom.add("hello")
// determine whether item is comtained in the bloom filter
bloom.contains("hello")

// create bloom filter with `BloomFilterBuilder`, that can mapping bitmap to file using mmap
let url = URL(string: "<path your want to mapping>")!
let bloom = BloomFilterBuilder.default
  .with(maxElements: max)
  .with { m in
    try! MmapBitmap(m, path: url)
  }.build()
// add item to filter
bloom.add("item1")
// determine whether item is comtained in the bloom filter
bloom.contains("item1")