RequestEntity class - request_entity library

Constructors

RequestEntity(String method, Uri requestedUri, {String? protocolVersion, Map<String, Object>? headers, String? handlerPath, Uri? url, Object? body, Encoding? encoding, Map<String, Object>? context, String? pathTemplate})

Properties

canHijack → bool: Whether this request can be hijacked.
no setterinherited
contentLength → int?: The contents of the content-length field in headers.
no setterinherited
context → Map<String, Object>: Extra context that can be used by for middleware and handlers.
finalinherited
encoding → Encoding?: The encoding of the message body.
no setterinherited
handlerPath → String: The URL path to the current handler.
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
headers → Map<String, String>: The HTTP headers with case-insensitive keys.
no setterinherited
headersAll → Map<String, List<String>>: The HTTP headers with multiple values with case-insensitive keys.
no setterinherited
httpMethod → HttpMethod: no setter
ifModifiedSince → DateTime?: If this is non-null and the requested resource hasn't been modified since this date and time, the server should return a 304 Not Modified response.
no setterinherited
isEmpty → bool: If true, the stream returned by read won't emit any bytes.
no setterinherited
method → String: The HTTP request method, such as "GET" or "POST".
finalinherited
mimeType → String?: The MIME type of the message.
no setterinherited
pathParams → Map<String, String>: no setter
pathTemplate → String?: no setter
protocolVersion → String: The HTTP protocol version used in the request, either "1.0" or "1.1".
finalinherited
queryParams → Map<String, String>: no setter
requestedUri → Uri: The original Uri for the request.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
url → Uri: The URL path from the current handler to the requested resource, relative to handlerPath, plus any query parameters.
finalinherited

Methods

body<T>({ObjectMapper? om}) → Future<T?>: Get the body of the request, it's get parsed with the ObjectMapper in the process It's algo get cached in case the method is called multiple times
change({Map<String, Object?>? headers, Map<String, Object?>? context, String? path, Object? body}) → Request: Creates a new Request by copying existing values and applying specified changes.
inherited
copyWith({Map<String, Object>? headers, Object? body, Encoding? encoding, Map<String, Object>? context}) → RequestEntity
formData() → FormDataRequest?: Available on Request, provided by the MultipartFromRequest extension
Calls FormDataRequest.of, returning a form-data representation of this request if it has the multipart content type.
hijack(void callback(StreamChannel<List<int>>)) → Never: Takes control of the underlying request socket.
inherited
multipart() → MultipartRequest?: Available on Request, provided by the MultipartFromRequest extension
Calls MultipartRequest.of, returning a multipart representation of this request if it has the multipart content type.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
read() → Stream<List<int>>: Returns a Stream representing the body.
inherited
readAsString([Encoding? encoding]) → Future<String>: Returns a Future containing the body as a String.
inherited
setUpPathParams(String template) → void: The path params need to be initialized with a template For the url: /user/adam/details
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited