*/
package jcifs.util.transport;

/**
 * Interface for transport response messages.
 * This interface represents responses received from network transports.
 */
public interface Response extends Message {

    /**
     * Checks if the response has been received.
     *
     * @return whether the response is received
     */
    boolean isReceived();

    /**
     * Set received status

# `Response` class

You can declare a parameter in a *path operation function* or dependency to be of type `Response` and then you can set data for the response like headers or cookies.

You can also use it directly to create an instance of it and return it from your *path operations*.

Read more about it in the [FastAPI docs about returning a custom Response](https://fastapi.tiangolo.com/advanced/response-directly/#returning-a-custom-response)

package org.codelibs.fess.suggest.request;

/**
 * The Response interface serves as a marker interface for all response types
 * in the suggestion system. Implementations of this interface are used to
 * encapsulate the results of various operations and queries within the system.
 *
 * <p>Classes implementing this interface should provide specific details and
 * data relevant to the type of response they represent.</p>
 */
public interface Response {

	w.WriteHeader(statusCode)
	if response != nil {
		w.Write(response)
	}
}

// mimeType represents various MIME type used API responses.
type mimeType string

const (
	// Means no response type.
	mimeNone mimeType = ""
	// Means response type is JSON.
	mimeJSON mimeType = "application/json"
	// Means response type is XML.

# Custom Response - HTML, Stream, File, others { #custom-response-html-stream-file-others }

By default, **FastAPI** will return JSON responses.

You can override it by returning a `Response` directly as seen in [Return a Response directly](response-directly.md).

# Headers de Response { #response-headers }

## Usa un parámetro `Response` { #use-a-response-parameter }

Puedes declarar un parámetro de tipo `Response` en tu *path operation function* (como puedes hacer para cookies).

Y luego puedes establecer headers en ese objeto de response *temporal*.

{* ../../docs_src/response_headers/tutorial002_py310.py hl[1, 7:8] *}

///

## Повернення `Response` { #return-a-response }

Ви можете повертати `Response` або будь-який його підклас.

/// info | Інформація

`JSONResponse` сам є підкласом `Response`.

///

І коли ви повертаєте `Response`, **FastAPI** передасть його безпосередньо.

Ви також можете оголосити параметр `Response` у залежностях і встановлювати в них кукі (і заголовки).

## Повертайте `Response` безпосередньо { #return-a-response-directly }

Ви також можете створювати кукі, повертаючи `Response` безпосередньо у вашому коді.

Для цього ви можете створити відповідь, як описано в [Повернути відповідь безпосередньо](response-directly.md).

Потім встановіть у ньому кукі і поверніть його:

Також ви можете оголосити параметр `Response` у залежностях і встановлювати в них заголовки (та кукі).

## Поверніть `Response` безпосередньо { #return-a-response-directly }

Ви також можете додавати заголовки, коли повертаєте `Response` безпосередньо.

Створіть відповідь, як описано в [Повернення Response безпосередньо](response-directly.md), і передайте заголовки як додатковий параметр:

# Réponse personnalisée - HTML, flux, fichier, autres { #custom-response-html-stream-file-others }

Par défaut, **FastAPI** renvoie des réponses JSON.

Vous pouvez le remplacer en renvoyant une `Response` directement comme vu dans [Renvoyer une Response directement](response-directly.md).