sftp_client

defmodule SFTPClient.Operations.ReadFile do
  @moduledoc """
  A module that provides functions to read file contents from an SFTP server.
  """

  import SFTPClient.OperationUtil

  alias SFTPClient.Conn

  @doc """
  Reads a file from the server, and returns the data as String.
  """
  @spec read_file(Conn.t(), Path.t()) ::
          {:ok, binary} | {:error, SFTPClient.error()}
  def read_file(%Conn{} = conn, path) do
    conn.channel_pid
    |> sftp_adapter().read_file(
      to_charlist(path),
      conn.config.operation_timeout
    )
    |> case do
      {:ok, content} -> {:ok, content}
      {:error, error} -> {:error, handle_error(error)}
    end
  end

  @doc """
  Reads a file from the server, and returns the data as String. Raises when the
  operation fails.
  """
  @spec read_file!(Conn.t(), Path.t()) :: binary | no_return
  def read_file!(%Conn{} = conn, path) do
    conn |> read_file(path) |> may_bang!()
  end
end