HtmlToMarkdown.WarningKind (html_to_markdown v3.11.4)

Copy Markdown

Categories of processing warnings.

Summary

Types

t()

Categories of processing warnings.

Functions

depth_limit_exceeded()

DOM traversal was truncated because max_depth was exceeded.

encoding_fallback()

The input encoding was not recognized; fell back to UTF-8.

image_extraction_failed()

An image could not be extracted (e.g. invalid data URI, unsupported format).

malformed_html()

The HTML was malformed but processing continued with best effort.

sanitization_applied()

Sanitization was applied to remove potentially unsafe content.

truncated_input()

The input was truncated due to size limits.

wire_value(atom)

Returns the serde wire value this variant carries on the JSON boundary (see wire_variant_value in alef's naming module) -- distinct from the atom's Elixir spelling.

Types

t()

@type t() ::
  :image_extraction_failed
  | :encoding_fallback
  | :truncated_input
  | :malformed_html
  | :sanitization_applied
  | :depth_limit_exceeded

Categories of processing warnings.

Functions

depth_limit_exceeded()

@spec depth_limit_exceeded() :: t()

DOM traversal was truncated because max_depth was exceeded.

encoding_fallback()

@spec encoding_fallback() :: t()

The input encoding was not recognized; fell back to UTF-8.

image_extraction_failed()

@spec image_extraction_failed() :: t()

An image could not be extracted (e.g. invalid data URI, unsupported format).

malformed_html()

@spec malformed_html() :: t()

The HTML was malformed but processing continued with best effort.

sanitization_applied()

@spec sanitization_applied() :: t()

Sanitization was applied to remove potentially unsafe content.

truncated_input()

@spec truncated_input() :: t()

The input was truncated due to size limits.

wire_value(atom)

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

Returns the serde wire value this variant carries on the JSON boundary (see wire_variant_value in alef's naming module) -- distinct from the atom's Elixir spelling.