HttpMultipartFormData class

HttpMultipartFormData class used for 'upgrading' a MimeMultipart by parsing it as a 'multipart/form-data' part. The following code shows how it can be used.

HttpServer server = ...; server.listen((request) { String boundary = request.headers.contentType.parameters'boundary'; request .transform(new MimeMultipartTransformer(boundary)) .map(HttpMultipartFormData.parse) .map((HttpMultipartFormData formData) { // form data object available here. });

HttpMultipartFormData is a Stream, serving either bytes or decoded Strings. Use isText or isBinary to see what type of data is provided.

Implemented types

Constructors

HttpMultipartFormData()

Properties

contentDisposition HeaderValue
The parsed Content-Disposition header of the HttpMultipartFormData. This field is always present. Use this to extract e.g. name(form field name)and filename (client provided name of uploaded file) parameters.
read-only
contentTransferEncoding HeaderValue
The parsed Content-Transfer-Encoding header of the HttpMultipartFormData. This field is used to determine how to decode the data. Returns null if not present.
read-only
contentType ContentType
The parsed Content-Type header of the HttpMultipartFormData. Returns null if not present.
read-only
first Future
The first element of this stream. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isBinary bool
Returns true if the data is raw bytes.
read-only
isBroadcast bool
Whether this stream is a broadcast stream.
read-only, inherited
isEmpty Future<bool>
Whether this stream contains any elements. [...]
read-only, inherited
isText bool
Returns true if the data is decoded as String.
read-only
last Future
The last element of this stream. [...]
read-only, inherited
length Future<int>
The number of elements in this stream. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
single Future
The single element of this stream. [...]
read-only, inherited

Methods

any(bool test(dynamic element)) Future<bool>
Checks whether test accepts any element provided by this stream. [...]
inherited
asBroadcastStream({void onListen(StreamSubscription subscription), void onCancel(StreamSubscription subscription)}) Stream
Returns a multi-subscription stream that produces the same events as this. [...]
inherited
asyncExpand<E>(Stream<E> convert(dynamic event)) Stream<E>
Transforms each element into a sequence of asynchronous events. [...]
inherited
asyncMap<E>(FutureOr<E> convert(dynamic event)) Stream<E>
Creates a new stream with each data event of this stream asynchronously mapped to a new event. [...]
inherited
cast<R>() Stream<R>
Adapt this stream to be a Stream<R>. [...]
inherited
contains(Object needle) Future<bool>
Returns whether needle occurs in the elements provided by this stream. [...]
inherited
distinct([bool equals(dynamic previous, dynamic next)]) Stream
Skips data events if they are equal to the previous data event. [...]
inherited
drain<E>([E futureValue]) Future<E>
Discards all data on this stream, but signals when it is done or an error occurred. [...]
inherited
elementAt(int index) Future
Returns the value of the indexth data event of this stream. [...]
inherited
every(bool test(dynamic element)) Future<bool>
Checks whether test accepts all elements provided by this stream. [...]
inherited
expand<S>(Iterable<S> convert(dynamic element)) Stream<S>
Transforms each element of this stream into a sequence of elements. [...]
inherited
firstWhere(bool test(dynamic element), {dynamic orElse()}) Future
Finds the first element of this stream matching test. [...]
inherited
fold<S>(S initialValue, S combine(S previous, dynamic element)) Future<S>
Combines a sequence of values by repeatedly applying combine. [...]
inherited
forEach(void action(dynamic element)) Future
Executes action on each element of this stream. [...]
inherited
handleError(Function onError, {bool test(dynamic error)}) Stream
Creates a wrapper Stream that intercepts some errors from this stream. [...]
inherited
join([String separator = ""]) Future<String>
Combines the string representation of elements into a single string. [...]
inherited
lastWhere(bool test(dynamic element), {dynamic orElse()}) Future
Finds the last element in this stream matching test. [...]
inherited
listen(void onData(dynamic event), {Function onError, void onDone(), bool cancelOnError}) StreamSubscription
Adds a subscription to this stream. [...]
inherited
map<S>(S convert(dynamic event)) Stream<S>
Transforms each element of this stream into a new stream event. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
pipe(StreamConsumer streamConsumer) Future
Pipes the events of this stream into streamConsumer. [...]
inherited
reduce(dynamic combine(dynamic previous, dynamic element)) Future
Combines a sequence of values by repeatedly applying combine. [...]
inherited
singleWhere(bool test(dynamic element), {dynamic orElse()}) Future
Finds the single element in this stream matching test. [...]
inherited
skip(int count) Stream
Skips the first count data events from this stream. [...]
inherited
skipWhile(bool test(dynamic element)) Stream
Skip data events from this stream while they are matched by test. [...]
inherited
take(int count) Stream
Provides at most the first count data events of this stream. [...]
inherited
takeWhile(bool test(dynamic element)) Stream
Forwards data events while test is successful. [...]
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink sink)}) Stream
Creates a new stream with the same events as this stream. [...]
inherited
toList() Future<List>
Collects all elements of this stream in a List. [...]
inherited
toSet() Future<Set>
Collects the data of this stream in a Set. [...]
inherited
toString() String
A string representation of this object. [...]
inherited
transform<S>(StreamTransformer<dynamic, S> streamTransformer) Stream<S>
Applies streamTransformer to this stream. [...]
inherited
value(String name) String
Returns the value for the header named name. If there is no header with the provided name, null will be returned. [...]
where(bool test(dynamic event)) Stream
Creates a new stream from this stream that discards some elements. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited

Static Methods

parse(MimeMultipart multipart, {Encoding defaultEncoding = utf8}) HttpMultipartFormData
Parse a MimeMultipart and return a HttpMultipartFormData. If the Content-Disposition header is missing or invalid, a HttpException is thrown. [...]