@spec convert(String.t(), options_input()) :: {:ok, String.t()} | {:error, term()}

Convert HTML to Markdown.

The options argument accepts an %HtmlToMarkdown.Options{} struct, a map/keyword list with option keys, or nil (defaults).

@spec convert!(String.t(), options_input()) :: String.t()

Convert HTML to Markdown and raise on failure.

@spec convert_with_inline_images(String.t(), options_input(), inline_config_input()) ::
  {:ok, String.t(), [HtmlToMarkdown.InlineImage.t()],
   [HtmlToMarkdown.InlineImageWarning.t()]}
  | {:error, term()}

Convert HTML and collect inline image assets.

Returns {:ok, markdown, inline_images, warnings}.

@spec convert_with_inline_images!(String.t(), options_input(), inline_config_input()) ::
  {String.t(), [HtmlToMarkdown.InlineImage.t()],
   [HtmlToMarkdown.InlineImageWarning.t()]}

Bang variant of convert_with_inline_images/3.

@spec convert_with_metadata(String.t(), options_input(), metadata_config_input()) ::
  {:ok, String.t(), map()} | {:error, term()}

Convert HTML to Markdown and extract metadata.

Returns {:ok, markdown, metadata}.

@spec convert_with_metadata!(String.t(), options_input(), metadata_config_input()) ::
  {String.t(), map()}

Bang variant of convert_with_metadata/3.

@spec convert_with_options(String.t(), reference()) ::
  {:ok, String.t()} | {:error, term()}

Convert HTML using a reusable options handle.

@spec convert_with_options!(String.t(), reference()) :: String.t()

Variant of convert_with_options/2 that raises on failure.

@spec options(options_input()) :: reference()

Create a reusable options handle (opaque reference).

The handle can be passed to convert_with_options/2.

@spec start_profiling(String.t(), integer()) :: :ok | {:error, term()}

Start Rust-side profiling and write a flamegraph to the given output path.

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

Stop Rust-side profiling and flush the flamegraph.