Saucexages v0.2.0 Saucexages.SauceRecord View Source

Represents a bare SAUCE record.

Comments are not stored in a SAUCE record, but rather the comment_lines field serves as a pointer of sorts to know where in a binary/file to begin reading the comment data.

Sauce records must contain at least a file_type and data_type. These two fields are used to interpret the following fields dependent on the combination of the two: t_info_1, t_info_2, t_info_3, t_info_4, t_flags,t_info_s. Each of these fields may contain information that may not be valid for the current file_type and data_type combination.

Link to this section Summary

Types

t()

Functions

new(version, file_type, data_type, opts \\ [])

Creates a new SAUCE record

Link to this section Types

t()

t() :: %Saucexages.SauceRecord{
  author: String.t() | nil,
  comment_lines: non_neg_integer() | nil,
  data_type: non_neg_integer(),
  date: DateTime.t() | nil,
  file_size: non_neg_integer() | nil,
  file_type: non_neg_integer(),
  group: String.t() | nil,
  t_flags: non_neg_integer() | nil,
  t_info_1: non_neg_integer() | nil,
  t_info_2: non_neg_integer() | nil,
  t_info_3: non_neg_integer() | nil,
  t_info_4: non_neg_integer() | nil,
  t_info_s: String.t() | nil,
  title: String.t() | nil,
  version: String.t()
}

Link to this section Functions

new(version, file_type, data_type, opts \\ [])

new(String.t(), non_neg_integer(), non_neg_integer(), Enum.t()) :: t()

Creates a new SAUCE record.