xserver library
Classes
- All
- AsciiCodec
- An AsciiCodec allows encoding strings as ASCII bytes and decoding ASCII bytes to strings.
- AsciiDecoder
- Converts ASCII bytes to string.
- AsciiEncoder
- Converts strings of only ASCII characters to bytes.
- Base64Codec
- A base64 encoder and decoder.
- Base64Decoder
- Decoder for base64 encoded data.
- Base64Encoder
- Base64 and base64url encoding converter.
- BaseClient
- The abstract base class for an HTTP client.
- BaseRequest
- The base class for HTTP requests.
- BaseResponse
- The base class for HTTP responses.
- BaseResponseWithUrl
- A BaseResponse with a url field.
- Body
- ByteConversionSink
- The ByteConversionSink provides an interface for converters to efficiently transmit byte data.
- ByteStream
- A stream of chunks of bytes representing a single piece of data.
-
ChunkedConversionSink<
T> - A ChunkedConversionSink is used to transmit data more efficiently between two converters during chunked conversions.
- Client
- The interface for HTTP clients that take care of maintaining persistent connections across multiple requests to the same server.
- ClosableStringSink
-
A ClosableStringSink extends the StringSink interface by adding a
closemethod. -
Codec<
S, T> - A Codec encodes and (if supported) decodes data.
-
Converter<
S, T> - A Converter converts data from one representation into another.
- DevClient
- Encoding
- Open-ended set of encodings.
- Get
- Header
- HtmlEscape
- Converter which escapes characters with special meaning in HTML.
- HtmlEscapeMode
- HTML escape modes.
- JsonCodec
- A JsonCodec encodes JSON objects to strings and decodes strings to JSON objects.
- JsonDecoder
- This class parses JSON strings and builds the corresponding objects.
- JsonEncoder
- This class converts JSON objects to strings.
- JsonUtf8Encoder
- Encoder that encodes a single object as a UTF-8 encoded JSON string.
- Latin1Codec
- A Latin1Codec encodes strings to ISO Latin-1 (aka ISO-8859-1) bytes and decodes Latin-1 bytes to strings.
- Latin1Decoder
- This class converts Latin-1 bytes (lists of unsigned 8-bit integers) to a string.
- Latin1Encoder
- This class converts strings of only ISO Latin-1 characters to bytes.
- LineSplitter
- A StreamTransformer that splits a String into individual lines.
- MultipartFile
- A file to be uploaded as part of a MultipartRequest.
- MultipartRequest
-
A
multipart/form-datarequest. - Path
- Post
- Query
- Request
- An HTTP request to be processed by a Shelf application.
- Response
-
The response returned by a
Handler. - Route
-
Annotation for handler methods that requests should be routed when using
package
shelf_router_generator. - Router
- A shelf Router routes requests to handlers based on HTTP verb and route pattern.
- SSEResponse
- SSEResponseComplete
- SSEResponseError
- SSEResponseNext
- StreamedRequest
- An HTTP request where the request body is sent asynchronously after the connection has been established and the headers have been sent.
- StreamedResponse
- An HTTP response where the response body is received asynchronously after the headers have been received.
- StringConversionSink
- A sink for converters to efficiently transmit String data.
- Utf8Codec
- A Utf8Codec encodes strings to utf-8 code units (bytes) and decodes UTF-8 code units to strings.
- Utf8Decoder
- This class converts UTF-8 code units (lists of unsigned 8-bit integers) to a string.
- Utf8Encoder
- This class converts strings to their UTF-8 code units (a list of unsigned 8-bit integers).
- XServer
- Annotation for XServer classes
- XServerBase
- XServerClientBase
- XServerParser
- XServerResponseHandler
Extensions
Constants
- all → const All
- ascii → const AsciiCodec
- An instance of the default implementation of the AsciiCodec.
- base64 → const Base64Codec
- A base64 encoder and decoder.
- base64Url → const Base64Codec
- A base64url encoder and decoder.
- body → const Body
- get → const Get
- header → const Header
- htmlEscape → const HtmlEscape
-
A
Stringconverter that converts characters to HTML entities. - json → const JsonCodec
- An instance of the default implementation of the JsonCodec.
- latin1 → const Latin1Codec
- An instance of the default implementation of the Latin1Codec.
- path → const Path
- post → const Post
- query → const Query
- unicodeBomCharacterRune → const int
-
The Unicode Byte Order Marker (BOM) character
U+FEFF. - unicodeReplacementCharacterRune → const int
-
The Unicode Replacement character
U+FFFD(�). - utf8 → const Utf8Codec
- An instance of the default implementation of the Utf8Codec.
- xServer → const XServer
Functions
-
base64Decode(
String source) → Uint8List - Decodes base64 or base64url encoded bytes.
-
base64Encode(
List< int> bytes) → String -
Encodes
bytesusing base64 encoding. -
base64UrlEncode(
List< int> bytes) → String -
Encodes
bytesusing base64url encoding. -
delete(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> - Sends an HTTP DELETE request with the given headers to the given URL.
-
head(
Uri url, {Map< String, String> ? headers}) → Future<Response> - Sends an HTTP HEAD request with the given headers to the given URL.
-
jsonDecode(
String source, {Object? reviver(Object? key, Object? value)?}) → dynamic - Parses the string and returns the resulting Json object.
-
jsonEncode(
Object? object, {Object? toEncodable(Object? nonEncodable)?}) → String -
Converts
objectto a JSON string. -
params(
Request request, String name) → String - Get a URL parameter captured by the Router.
-
patch(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> - Sends an HTTP PATCH request with the given headers and body to the given URL.
-
put(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> - Sends an HTTP PUT request with the given headers and body to the given URL.
-
read(
Uri url, {Map< String, String> ? headers}) → Future<String> - Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
-
readBytes(
Uri url, {Map< String, String> ? headers}) → Future<Uint8List> - Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
-
runWithClient<
R> (R body(), Client clientFactory(), {ZoneSpecification? zoneSpecification}) → R -
Runs
bodyin its own Zone with the Client returned byclientFactoryset as the default Client. -
useRequest(
) → Request
Typedefs
- ByteConversionSinkBase = ByteConversionSink
- This class provides a base-class for converters that need to accept byte inputs.
-
HandlerFunction<
T> = FutureOr< Response> Function(Request request) - StringConversionSinkBase = StringConversionSink
- This class provides a base-class for converters that need to accept String inputs.
- StringConversionSinkMixin = StringConversionSink
- This class provides a mixin for converters that need to accept String inputs.
Exceptions / Errors
- BadRequestException
- ClientException
- An exception caused by an error in a pkg/http client.
- JsonCyclicError
- Reports that an object could not be stringified due to cyclic references.
- JsonUnsupportedObjectError
- Error thrown by JSON serialization if an object cannot be serialized.