SnmpKit.SnmpLib.MIB (snmpkit v0.6.6)

@type compile_opts() :: [
  output_dir: Path.t(),
  include_dirs: [Path.t()],
  log_level: Logger.level(),
  format: :elixir | :erlang | :both,
  optimize: boolean(),
  warnings_as_errors: boolean(),
  vendor_quirks: boolean()
]

compile_result()

@type compile_result() ::
  {:ok, compiled_mib()}
  | {:error, [error()]}
  | {:warning, compiled_mib(), [warning()]}

compiled_mib()

@type compiled_mib() :: %{
  name: binary(),
  objects_count: non_neg_integer(),
  output_path: Path.t(),
  compilation_time: non_neg_integer(),
  metadata: map()
}

error()

@type error() :: term()

warning()

@type warning() :: term()

Functions

compile(mib_source, opts \\ [])

@spec compile(Path.t() | binary(), compile_opts()) ::
  {:error, [SnmpKit.SnmpLib.MIB.Error.t()]}

Compile a MIB file to Elixir code.

Options

:output_dir - Directory for generated files (default: "./lib/generated")
:include_dirs - Directories to search for imported MIBs (default: ["./priv/mibs"])
:log_level - Logging verbosity (default: :info)
:format - Output format :elixir, :erlang, or :both (default: :elixir)
:optimize - Enable performance optimizations (default: true)
:warnings_as_errors - Treat warnings as compilation errors (default: false)
:vendor_quirks - Enable vendor-specific MIB compatibility (default: true)

Examples

iex> SnmpKit.SnmpLib.MIB.compile("priv/mibs/RFC1213-MIB.txt")
{:error, [%SnmpKit.SnmpLib.MIB.Error{type: :file_not_found, ...}]}

compile_all(mib_files, opts \\ [])

@spec compile_all([Path.t()], compile_opts()) ::
  {:ok, [compiled_mib()]} | {:error, [{Path.t(), [error()]}]}

Compile multiple MIB files in dependency order.

Automatically resolves import dependencies and compiles MIBs in the correct order.

Examples

iex> mibs = ["SNMPv2-SMI.txt", "SNMPv2-TC.txt", "RFC1213-MIB.txt"]
iex> SnmpKit.SnmpLib.MIB.compile_all(mibs)
{:ok, [%{name: "SNMPv2-SMI", ...}, %{name: "SNMPv2-TC", ...}, ...]}

compile_string(mib_content, opts \\ [])

@spec compile_string(binary(), compile_opts()) ::
  {:error, [SnmpKit.SnmpLib.MIB.Error.t()]}

Compile MIB content from a string.

Useful when the MIB content is already loaded or generated dynamically.

Examples

iex> mib_content = File.read!("RFC1213-MIB.txt")
iex> SnmpKit.SnmpLib.MIB.compile_string(mib_content)
{:ok, %{name: "RFC1213-MIB", ...}}

load_compiled(compiled_path)

@spec load_compiled(Path.t()) :: {:ok, compiled_mib()} | {:error, term()}

Load a previously compiled MIB module.

Examples

iex> SnmpKit.SnmpLib.MIB.load_compiled("lib/generated/rfc1213_mib.ex")
{:ok, %{name: "RFC1213-MIB", ...}}