reverse-engineering-anything/src/application/binaryDiagnostics/BinaryLayoutPort.ts

import type {
  ExecutionOptions,
  ProviderIdentity,
} from "../AnalysisProvider.js";
import type { AnalysisError } from "../../domain/analysisErrorBase.js";
import type {
  BinaryLayout,
  InspectBinaryLayoutInput,
} from "../../domain/native/binaryLayout.js";
import type { Result } from "../../domain/result.js";

/** Replaceable offline binary-layout provider; owns its parser and process protocol. */
export interface BinaryLayoutPort {
  readonly identity: ProviderIdentity;
  inspectAndClose(
    input: InspectBinaryLayoutInput,
    options?: ExecutionOptions,
  ): Promise<Result<BinaryLayout, AnalysisError>>;
  close?(): Promise<void>;
  inspect(
    input: InspectBinaryLayoutInput,
    options?: ExecutionOptions,
  ): Promise<Result<BinaryLayout, AnalysisError>>;
}