Kreuzberg.RelationshipKind (kreuzberg v4.9.5)

Copy Markdown View Source

Enumeration of relationship kinds between document elements.

Matches the Rust RelationshipKind enum.

Values

  • :footnote_reference - Reference to a footnote
  • :citation_reference - Reference to a citation
  • :internal_link - Internal document link
  • :caption - Caption relationship
  • :label - Label relationship
  • :toc_entry - Table of contents entry
  • :cross_reference - Cross-reference between elements

Summary

Types

t()

Functions

values()

Returns all valid RelationshipKind values.

Types

t()

@type t() ::
  :footnote_reference
  | :citation_reference
  | :internal_link
  | :caption
  | :label
  | :toc_entry
  | :cross_reference

Functions

values()

@spec values() :: [t()]

Returns all valid RelationshipKind values.

Examples

iex> Kreuzberg.RelationshipKind.values()
[:footnote_reference, :citation_reference, :internal_link, :caption, :label, :toc_entry, :cross_reference]