Smee.Filter (Smee v0.1.0) View Source

Process a stream of entities to include or exclude entity structs matching the specified criteria.

These functions are intended to be used with streams but should also work with simple lists too - but using lists to process larger metadata files is strongly discouraged.

By default these functions include matching entities and exclude those that do not match, but this an be reversed. By default Smee.Filter.idp/3 will exclude entities that are no IdPs. But by specifying false as the third parameter the filter will be inverted and exclude entities that have an IdP role.

Link to this section Summary

Functions

Filters a stream of entities to include or exclude those that have an IdP role.

Filters a stream of entities to include or exclude those that have an SP role.

Filters a stream of entities to include or exclude those that have a trustiness equal or less than the specified number.

Filters a stream of entities to include or exclude those that have one of the specified IDs.

Link to this section Functions

Specs

idp(enum :: Enumerable.t(), bool :: boolean()) :: Enumerable.t()

Filters a stream of entities to include or exclude those that have an IdP role.

The filter is positive by default but can be inverted by specifying false

Specs

sp(enum :: Enumerable.t(), bool :: boolean()) :: Enumerable.t()

Filters a stream of entities to include or exclude those that have an SP role.

The filter is positive by default but can be inverted by specifying false

Link to this function

trustiness(enum, trustiness \\ 0.7, bool \\ true)

View Source

Specs

trustiness(enum :: Enumerable.t(), trustiness :: float(), bool :: boolean()) ::
  Enumerable.t()

Filters a stream of entities to include or exclude those that have a trustiness equal or less than the specified number.

Trustiness values are between 0.0 and 0.9.

The filter is positive by default but can be inverted by specifying false

Link to this function

uri(enum, uris, bool \\ true)

View Source

Specs

uri(enum :: Enumerable.t(), uris :: list() | binary(), bool :: boolean()) ::
  Enumerable.t()

Filters a stream of entities to include or exclude those that have one of the specified IDs.

The filter is positive by default but can be inverted by specifying false