Kombu.Utils.URL (Kombu v0.1.0)

Copy Markdown View Source

URL parsing and sanitization utilities matching kombu.utils.url.

Summary

Functions

Format URL components into a URL string matching kombu.utils.url.as_url.

Sanitize url if it is a URL string containing "://", otherwise return as-is.

Parse ssl_cert_reqs query parameter value.

Parse a URL string into a map of connection parameters matching kombu.utils.url.parse_url.

Encode a string escaping all reserved characters including /.

Return a copy of url with the password masked.

Parse a URL into %Kombu.Utils.URL.Parts{} matching kombu.utils.url.url_to_parts.

Functions

as_url(scheme)

Format URL components into a URL string matching kombu.utils.url.as_url.

as_url(scheme, opts)

as_url(scheme, host, port)

as_url(scheme, host, port, user)

as_url(scheme, host, port, user, password)

as_url(scheme, host, port, user, password, path)

as_url(scheme, host, port, user, password, path, query)

as_url(scheme, host, port, user, password, path, query, opts)

@spec as_url(
  String.t(),
  String.t() | nil,
  integer() | nil,
  String.t() | nil,
  String.t() | nil,
  String.t() | nil,
  map() | nil,
  keyword()
) :: String.t()

maybe_sanitize_url(url, mask \\ "**")

@spec maybe_sanitize_url(term(), String.t()) :: term()

Sanitize url if it is a URL string containing "://", otherwise return as-is.

parse_ssl_cert_reqs(query_value, ssl_available \\ true)

@spec parse_ssl_cert_reqs(String.t(), boolean() | nil) :: atom() | nil

Parse ssl_cert_reqs query parameter value.

parse_url(url, opts \\ [])

@spec parse_url(String.t(), keyword()) :: map()

Parse a URL string into a map of connection parameters matching kombu.utils.url.parse_url.

safequote(str)

@spec safequote(String.t()) :: String.t()

Encode a string escaping all reserved characters including /.

sanitize_url(url, mask \\ "**")

@spec sanitize_url(String.t(), String.t()) :: String.t()

Return a copy of url with the password masked.

url_to_parts(url)

@spec url_to_parts(String.t()) :: Kombu.Utils.URL.Parts.t()

Parse a URL into %Kombu.Utils.URL.Parts{} matching kombu.utils.url.url_to_parts.