Module efuse_filter

Interface for the fuse8 filter.

Copyright © (C) 2021, Matthew Pope

Authors: Matthew Pope.

Description

Interface for the fuse8 filter.

Example usage:
  Filter = fuse8:new(["cat", "dog", "mouse"]),
  true   = fuse8:contain(Filter, "cat"),
  false  = fuse8:contain(Filter, "goose").
Incremental Init:
  Filter0 = fuse8:new_empty(),
  Filter1 = fuse8:add([1, 2]),
  Filter2 = fuse8:add([3, 4]),
  Filter3 = fuse8:finalize(Filter2),
 
  true = fuse8:contain(Filter3, 1),
  false = fuse8:contain(Filter3, 5).
 
  Default Return Values:
  `fuse8:contain/3' can return a default value.
  Filter = fuse8:new(["Ricky Bobby", "Cal Naughton Jr."]),
  true = fuse8:contain(Filter, "Ricky Bobby", {error, not_found}),
  {error, not_found} = fuse8:contain(Filter, "Reese Bobby", {error, not_found}).

Function Index

fuse8_contain_nif/2
fuse8_from_bin_nif/1
fuse8_initialize_nif/1
fuse8_initialize_nif_dirty/1
fuse8_to_bin_nif/1

Function Details

fuse8_contain_nif/2

fuse8_contain_nif(X1, X2) -> any()

fuse8_from_bin_nif/1

fuse8_from_bin_nif(X1) -> any()

fuse8_initialize_nif/1

fuse8_initialize_nif(X1) -> any()

fuse8_initialize_nif_dirty/1

fuse8_initialize_nif_dirty(X1) -> any()

fuse8_to_bin_nif/1

fuse8_to_bin_nif(X1) -> any()


Generated by EDoc