# codegen: do not edit
defmodule GenLSP.Requests.WorkspaceWillRenameFiles do
  @moduledoc """
  The will rename files request is sent from the client to the server before files are actually
  renamed as long as the rename is triggered from within the client.

  @since 3.16.0

  Message Direction: clientToServer
  """

  import SchematicV, warn: false

  use TypedStruct

  typedstruct do
    field(:method, String.t(), default: "workspace/willRenameFiles")
    field(:jsonrpc, String.t(), default: "2.0")
    field(:id, integer(), enforce: true)
    field(:params, GenLSP.Structures.RenameFilesParams.t())
  end

  @type result :: GenLSP.Structures.WorkspaceEdit.t() | nil

  @doc false
  @spec schematic() :: SchematicV.t()
  def schematic() do
    schema(__MODULE__, %{
      method: "workspace/willRenameFiles",
      jsonrpc: "2.0",
      id: int(),
      params: GenLSP.Structures.RenameFilesParams.schematic()
    })
  end

  @doc false
  @spec result() :: SchematicV.t()
  def result() do
    oneof([
      oneof([GenLSP.Structures.WorkspaceEdit.schematic(), nil]),
      GenLSP.ErrorResponse.schematic()
    ])
  end
end
