View Source Disposable.Source (Disposable v0.2.0)

Loads and validates disposable-domain sources.

Source files are UTF-8, newline-delimited, ASCII domain lists. Punycode labels are accepted, but Unicode domain labels are intentionally not normalized.

Summary

Types

limits()

source()

Functions

configured_source()

Returns the configured source, including the deprecated file setting.

configured_url_options()

Returns the configured URL-loading options.

load(source, opts \\ [])

Loads and parses a configured source.

parse(contents, opts \\ [])

Parses a UTF-8 newline-delimited domain list.

valid_domain?(domain)

Validates one ASCII domain using exact-domain matching rules.

validate_domains(domains)

Validates a parsed domain set before publication.

Types

limits()

@type limits() :: [
  max_source_bytes: pos_integer(),
  max_line_bytes: pos_integer(),
  max_domain_count: pos_integer()
]

source()

@type source() :: :bundled | {:file, String.t()} | {:url, String.t()}

Functions

configured_source()

@spec configured_source() :: term()

Returns the configured source, including the deprecated file setting.

configured_url_options()

@spec configured_url_options() :: keyword()

Returns the configured URL-loading options.

load(source, opts \\ [])

@spec load(
  term(),
  keyword()
) :: {:ok, MapSet.t()} | {:error, term()}

Loads and parses a configured source.

parse(contents, opts \\ [])

@spec parse(
  binary(),
  keyword()
) :: {:ok, MapSet.t()} | {:error, term()}

Parses a UTF-8 newline-delimited domain list.

valid_domain?(domain)

@spec valid_domain?(term()) :: boolean()

Validates one ASCII domain using exact-domain matching rules.

validate_domains(domains)

@spec validate_domains(term()) :: :ok | {:error, term()}

Validates a parsed domain set before publication.