Response (FsHttp)

Response Module

Namespace: FsHttp
Assembly: FsHttp.dll

Functions and values

Function or value	Description
`asOriginalHttpRequestMessage response` Full Usage: `asOriginalHttpRequestMessage response` Parameters: response : `Response` Returns: `HttpRequestMessage`	response : `Response` Returns: `HttpRequestMessage`
`asOriginalHttpResponseMessage response` Full Usage: `asOriginalHttpResponseMessage response` Parameters: response : `Response` Returns: `HttpResponseMessage`	response : `Response` Returns: `HttpResponseMessage`
`assert1xx response` Full Usage: `assert1xx response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assert2xx response` Full Usage: `assert2xx response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assert3xx response` Full Usage: `assert3xx response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assert4xx response` Full Usage: `assert4xx response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assert5xx response` Full Usage: `assert5xx response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assert9xx response` Full Usage: `assert9xx response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assertBadRequest response` Full Usage: `assertBadRequest response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assertForbidden response` Full Usage: `assertForbidden response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assertHttpStatusCode code response` Full Usage: `assertHttpStatusCode code response` Parameters: code : `HttpStatusCode` response : `Response` Returns: `Response`	code : `HttpStatusCode` response : `Response` Returns: `Response`
`assertHttpStatusCodes codes response` Full Usage: `assertHttpStatusCodes codes response` Parameters: codes : `HttpStatusCode list` response : `Response` Returns: `Response`	codes : `HttpStatusCode list` response : `Response` Returns: `Response`
`assertNoContent response` Full Usage: `assertNoContent response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assertNotFound response` Full Usage: `assertNotFound response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assertOk response` Full Usage: `assertOk response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`assertStatusCode code response` Full Usage: `assertStatusCode code response` Parameters: code : `int` response : `Response` Returns: `Response`	code : `int` response : `Response` Returns: `Response`
`assertStatusCodes codes response` Full Usage: `assertStatusCodes codes response` Parameters: codes : `int list` response : `Response` Returns: `Response`	codes : `int list` response : `Response` Returns: `Response`
`assertUnauthorized response` Full Usage: `assertUnauthorized response` Parameters: response : `Response` Returns: `Response`	response : `Response` Returns: `Response`
`deserializeJson response` Full Usage: `deserializeJson response` Parameters: response : `Response` Returns: `'a`	response : `Response` Returns: `'a`
`deserializeJsonAsync response` Full Usage: `deserializeJsonAsync response` Parameters: response : `Response` Returns: `Async<'a>`	response : `Response` Returns: `Async<'a>`
`deserializeJsonTAsync cancellationToken response` Full Usage: `deserializeJsonTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<'a>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<'a>`
`deserializeJsonWith options response` Full Usage: `deserializeJsonWith options response` Parameters: options : `JsonSerializerOptions` response : `Response` Returns: `'a`	options : `JsonSerializerOptions` response : `Response` Returns: `'a`
`deserializeJsonWithAsync options response` Full Usage: `deserializeJsonWithAsync options response` Parameters: options : `JsonSerializerOptions` response : `Response` Returns: `Async<'a>`	options : `JsonSerializerOptions` response : `Response` Returns: `Async<'a>`
`deserializeJsonWithTAsync options cancellationToken response` Full Usage: `deserializeJsonWithTAsync options cancellationToken response` Parameters: options : `JsonSerializerOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<'a>`	options : `JsonSerializerOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<'a>`
`expectHttpStatusCode code` Full Usage: `expectHttpStatusCode code` Parameters: code : `HttpStatusCode` Returns: `Response -> Result<Response, StatusCodeExpectation>`	code : `HttpStatusCode` Returns: `Response -> Result<Response, StatusCodeExpectation>`
`expectHttpStatusCodes codes response` Full Usage: `expectHttpStatusCodes codes response` Parameters: codes : `HttpStatusCode list` response : `Response` Returns: `Result<Response, StatusCodeExpectation>`	codes : `HttpStatusCode list` response : `Response` Returns: `Result<Response, StatusCodeExpectation>`
`expectStatusCode code` Full Usage: `expectStatusCode code` Parameters: code : `int` Returns: `Response -> Result<Response, StatusCodeExpectation>`	code : `int` Returns: `Response -> Result<Response, StatusCodeExpectation>`
`expectStatusCodes codes` Full Usage: `expectStatusCodes codes` Parameters: codes : `int list` Returns: `Response -> Result<Response, StatusCodeExpectation>`	codes : `int list` Returns: `Response -> Result<Response, StatusCodeExpectation>`
`loadContent response` Full Usage: `loadContent response` Parameters: response : `Response` Returns: `Response`	Starts serializing the content stream into a buffer as a background task. response : `Response` Returns: `Response`
`parseAsync parserName parse response` Full Usage: `parseAsync parserName parse response` Parameters: parserName : `string` parse : `Stream -> CancellationToken -> Async<'a>` response : `Response` Returns: `Async<'a>`	parserName : `string` parse : `Stream -> CancellationToken -> Async<'a>` response : `Response` Returns: `Async<'a>`
`saveFile fileName response` Full Usage: `saveFile fileName response` Parameters: fileName : `string` response : `Response`	fileName : `string` response : `Response`
`saveFileAsync fileName response` Full Usage: `saveFileAsync fileName response` Parameters: fileName : `string` response : `Response` Returns: `Async<unit>`	fileName : `string` response : `Response` Returns: `Async<unit>`
`saveFileTAsync fileName cancellationToken response` Full Usage: `saveFileTAsync fileName cancellationToken response` Parameters: fileName : `string` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<unit>`	fileName : `string` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<unit>`
`toBytes response` Full Usage: `toBytes response` Parameters: response : `Response` Returns: `byte[]`	response : `Response` Returns: `byte[]`
`toBytesAsync response` Full Usage: `toBytesAsync response` Parameters: response : `Response` Returns: `Async<byte[]>`	response : `Response` Returns: `Async<byte[]>`
`toBytesTAsync cancellationToken response` Full Usage: `toBytesTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<byte[]>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<byte[]>`
`toFormattedText response` Full Usage: `toFormattedText response` Parameters: response : `Response` Returns: `string`	response : `Response` Returns: `string`
`toFormattedTextAsync response` Full Usage: `toFormattedTextAsync response` Parameters: response : `Response` Returns: `Async<string>`	Tries to convert the response content according to it's type to a formatted string. response : `Response` Returns: `Async<string>`
`toFormattedTextTAsync cancellationToken response` Full Usage: `toFormattedTextTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<string>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<string>`
`toJson response` Full Usage: `toJson response` Parameters: response : `Response` Returns: `JsonElement`	response : `Response` Returns: `JsonElement`
`toJsonArray response` Full Usage: `toJsonArray response` Parameters: response : `Response` Returns: `JsonElement[]`	response : `Response` Returns: `JsonElement[]`
`toJsonArrayAsync response` Full Usage: `toJsonArrayAsync response` Parameters: response : `Response` Returns: `Async<JsonElement[]>`	response : `Response` Returns: `Async<JsonElement[]>`
`toJsonArrayTAsync cancellationToken response` Full Usage: `toJsonArrayTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement[]>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement[]>`
`toJsonArrayWith options response` Full Usage: `toJsonArrayWith options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `JsonElement[]`	options : `JsonDocumentOptions` response : `Response` Returns: `JsonElement[]`
`toJsonArrayWithAsync options response` Full Usage: `toJsonArrayWithAsync options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonElement[]>`	options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonElement[]>`
`toJsonArrayWithTAsync options cancellationToken response` Full Usage: `toJsonArrayWithTAsync options cancellationToken response` Parameters: options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement[]>`	options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement[]>`
`toJsonAsync response` Full Usage: `toJsonAsync response` Parameters: response : `Response` Returns: `Async<JsonElement>`	response : `Response` Returns: `Async<JsonElement>`
`toJsonDocument response` Full Usage: `toJsonDocument response` Parameters: response : `Response` Returns: `JsonDocument`	response : `Response` Returns: `JsonDocument`
`toJsonDocumentAsync response` Full Usage: `toJsonDocumentAsync response` Parameters: response : `Response` Returns: `Async<JsonDocument>`	response : `Response` Returns: `Async<JsonDocument>`
`toJsonDocumentTAsync cancellationToken response` Full Usage: `toJsonDocumentTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonDocument>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonDocument>`
`toJsonDocumentWith options response` Full Usage: `toJsonDocumentWith options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `JsonDocument`	options : `JsonDocumentOptions` response : `Response` Returns: `JsonDocument`
`toJsonDocumentWithAsync options response` Full Usage: `toJsonDocumentWithAsync options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonDocument>`	options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonDocument>`
`toJsonDocumentWithTAsync options cancellationToken response` Full Usage: `toJsonDocumentWithTAsync options cancellationToken response` Parameters: options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonDocument>`	options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonDocument>`
`toJsonList response` Full Usage: `toJsonList response` Parameters: response : `Response` Returns: `JsonElement list`	response : `Response` Returns: `JsonElement list`
`toJsonListAsync response` Full Usage: `toJsonListAsync response` Parameters: response : `Response` Returns: `Async<JsonElement list>`	response : `Response` Returns: `Async<JsonElement list>`
`toJsonListTAsync cancellationToken response` Full Usage: `toJsonListTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement list>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement list>`
`toJsonListWith options response` Full Usage: `toJsonListWith options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `JsonElement list`	options : `JsonDocumentOptions` response : `Response` Returns: `JsonElement list`
`toJsonListWithAsync options response` Full Usage: `toJsonListWithAsync options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonElement list>`	options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonElement list>`
`toJsonListWithTAsync options cancellationToken response` Full Usage: `toJsonListWithTAsync options cancellationToken response` Parameters: options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement list>`	options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement list>`
`toJsonSeq response` Full Usage: `toJsonSeq response` Parameters: response : `Response` Returns: `ArrayEnumerator`	response : `Response` Returns: `ArrayEnumerator`
`toJsonSeqAsync response` Full Usage: `toJsonSeqAsync response` Parameters: response : `Response` Returns: `Async<ArrayEnumerator>`	response : `Response` Returns: `Async<ArrayEnumerator>`
`toJsonSeqTAsync cancellationToken response` Full Usage: `toJsonSeqTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<ArrayEnumerator>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<ArrayEnumerator>`
`toJsonSeqWith options response` Full Usage: `toJsonSeqWith options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `ArrayEnumerator`	options : `JsonDocumentOptions` response : `Response` Returns: `ArrayEnumerator`
`toJsonSeqWithAsync options response` Full Usage: `toJsonSeqWithAsync options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `Async<ArrayEnumerator>`	options : `JsonDocumentOptions` response : `Response` Returns: `Async<ArrayEnumerator>`
`toJsonSeqWithTAsync options cancellationToken response` Full Usage: `toJsonSeqWithTAsync options cancellationToken response` Parameters: options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<ArrayEnumerator>`	options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<ArrayEnumerator>`
`toJsonTAsync cancellationToken response` Full Usage: `toJsonTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement>`
`toJsonWith options response` Full Usage: `toJsonWith options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `JsonElement`	options : `JsonDocumentOptions` response : `Response` Returns: `JsonElement`
`toJsonWithAsync options response` Full Usage: `toJsonWithAsync options response` Parameters: options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonElement>`	options : `JsonDocumentOptions` response : `Response` Returns: `Async<JsonElement>`
`toJsonWithTAsync options cancellationToken response` Full Usage: `toJsonWithTAsync options cancellationToken response` Parameters: options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement>`	options : `JsonDocumentOptions` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<JsonElement>`
`toResult response` Full Usage: `toResult response` Parameters: response : `Response` Returns: `Result<Response, Response>`	response : `Response` Returns: `Result<Response, Response>`
`toStream response` Full Usage: `toStream response` Parameters: response : `Response` Returns: `Stream`	response : `Response` Returns: `Stream`
`toStreamAsync response` Full Usage: `toStreamAsync response` Parameters: response : `Response` Returns: `Async<Stream>`	response : `Response` Returns: `Async<Stream>`
`toStreamTAsync cancellationToken response` Full Usage: `toStreamTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<Stream>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<Stream>`
`toString maxLength response` Full Usage: `toString maxLength response` Parameters: maxLength : `int option` response : `Response` Returns: `string`	maxLength : `int option` response : `Response` Returns: `string`
`toStringAsync maxLength response` Full Usage: `toStringAsync maxLength response` Parameters: maxLength : `int option` response : `Response` Returns: `Async<string>`	maxLength : `int option` response : `Response` Returns: `Async<string>`
`toStringTAsync maxLength cancellationToken response` Full Usage: `toStringTAsync maxLength cancellationToken response` Parameters: maxLength : `int option` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<string>`	maxLength : `int option` cancellationToken : `CancellationToken` response : `Response` Returns: `Task<string>`
`toText response` Full Usage: `toText response` Parameters: response : `Response` Returns: `string`	response : `Response` Returns: `string`
`toTextAsync response` Full Usage: `toTextAsync response` Parameters: response : `Response` Returns: `Async<string>`	response : `Response` Returns: `Async<string>`
`toTextTAsync cancellationToken response` Full Usage: `toTextTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<string>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<string>`
`toXml response` Full Usage: `toXml response` Parameters: response : `Response` Returns: `XDocument`	response : `Response` Returns: `XDocument`
`toXmlAsync response` Full Usage: `toXmlAsync response` Parameters: response : `Response` Returns: `Async<XDocument>`	response : `Response` Returns: `Async<XDocument>`
`toXmlTAsync cancellationToken response` Full Usage: `toXmlTAsync cancellationToken response` Parameters: cancellationToken : `CancellationToken` response : `Response` Returns: `Task<XDocument>`	cancellationToken : `CancellationToken` response : `Response` Returns: `Task<XDocument>`