ArchAstro.Types.ContextDocumentContent (archastro v0.2.0)

Copy Markdown

The text content of a context document, optionally sliced by line or byte range. Includes totals and slice boundary fields for the requested unit.

Summary

Types

t()

Functions

from_map(data)
matches?(value)
to_map(value)

Types

t()

@type t() :: %ArchAstro.Types.ContextDocumentContent{
  content: String.t(),
  end_byte: integer() | ArchAstro.Unset.t(),
  end_line: integer() | ArchAstro.Unset.t(),
  id: String.t(),
  limit: integer() | ArchAstro.Unset.t(),
  metadata: %{optional(String.t()) => ArchAstro.JSON.t()} | ArchAstro.Unset.t(),
  offset: integer() | ArchAstro.Unset.t(),
  start_byte: integer() | ArchAstro.Unset.t(),
  start_line: integer() | ArchAstro.Unset.t(),
  title: String.t() | ArchAstro.Unset.t(),
  total_lines: integer(),
  total_size: integer(),
  unit: String.t() | ArchAstro.Unset.t()
}

Functions

from_map(data)

@spec from_map(ArchAstro.JSON.object()) :: t()

matches?(value)

@spec matches?(ArchAstro.JSON.t()) :: boolean()

to_map(value)

@spec to_map(t()) :: ArchAstro.JSON.object()