future_server library

Support for doing something awesome.

More dartdocs go here.

Classes

AsyncSnapshot<T>
BinaryReader
The BinaryReader is used to bring data back from the binary format on the disk.
BinaryWriter
The BinaryWriter is used to encode data to the binary format.
Bindings
Bindings should be extended. Used to start your instances
BindingsBuilder<T>
Simplifies Bindings generation from a single callback. To avoid the creation of a custom Binding instance per route.
Box<E>
Boxes contain all of your data. In the browser, each box has its own IndexedDB database. On all other platforms, each Box is stored in a separate file in the Hive home directory.
BoxBase<E>
Boxes contain all of your data. In the browser, each box has its own IndexedDB database. On all other platforms, each Box is stored in a seperate file in the Hive home directory.
BoxCollection
BoxEvent
A event representing a change in a box.
BuildContext
BytesData
Close
CollectionBox<V>
represents a Box being part of a BoxCollection
ComponentElement
ConnectionSettings
ContextRequest
DisposableInterface
Element
Error
FastList<T>
FolderWidget
FormData
FullHeadersWidget
FutureBuilder<T>
FutureFile
FutureMYSQL
FutureServer
FutureServerApp
FutureServerController
FutureServerInterface
FutureWidget
GetConnect
GetConnectInterface
GetEndpoint<T>
GetHttpClient
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get" class through extensions
GetLifeCycle
GetMicrotask
GetPage
GetPlatform
GetQueue
GetServerController
GetSocket
GetSocketClient
GetStream<T>
GetStream is the lightest and most performative way of working with events at Dart. You sintaxe is like StreamController, but it works with simple callbacks. In this way, every event calls only one function. There is no buffering, to very low memory consumption. event add will add a object to stream. addError will add a error to stream. listen is a very light StreamSubscription interface. Is possible take the last value with value property.
GetStreamTransformation<T>
GetUtils
GetView<T>
GetWidget<T>
GetxController
GetxService
Unlike GetxController, which serves to control events on each of its pages, GetxService is not automatically disposed (nor can be removed with Get.delete()). It is ideal for situations where, once started, that service will remain in memory, such as Auth control for example. Only way to remove it is Get.reset().
GraphQLResponse<T>
HasCurrentIterator<E>
HeaderValue
HeaderWidget
HiveAesCipher
Default encryption algorithm. Uses AES256 CBC with PKCS7 padding.
HiveCipher
Abstract cipher can be implemented to customize encryption.
HiveCollection<E extends HiveObjectMixin>
List containing HiveObjectMixins.
HiveField
Annotate all fields you want to persist with HiveField.
HiveInterface
The main API interface of Hive. Available through the Hive constant.
HiveList<E extends HiveObjectMixin>
Allows defining references to other HiveObjectMixins.
HiveObject
HiveType
Annotate classes with HiveType to generate a TypeAdapter.
Html
HtmlText
HttpMultipartFormData
InstanceInfo
Json
Key
LazyBox<E>
LazyBoxes don't keep the values in memory like normal boxes. Each time a value is read, it is loaded from the backend.
LightSubscription<T>
Locale
LocalKey
A key that is not a GlobalKey.
MiniStream<T>
MiniSubscription<T>
MultipartFile
MultipartUpload
MultiPartWidget
MultiPartWidgetState
MySqlConnection
Represents a connection to the database. Use connect to open a connection. You must call close when you are done.
Node<T>
NodeWidgetWrapper
Obx
The simplest reactive widget in GetX.
ObxState
ObxWidget
OpenBoxex
Pageable
PageRedirect
PayloadWidget
PayloadWidgetState
Public
RegisterHives
Response<T>
Results
An iterable of result rows returned by MySqlConnection.query or MySqlConnection.queryMulti.
Route
RouteConfig
RouteParser
Rx<T>
Foundation class used for custom Types outside the common native Dart types. For example, any custom "Model" class, like User().obs will use Rx as wrapper.
RxBool
RxDouble
RxInt
RxInterface<T>
This class is the foundation for all reactive (Rx) classes that makes Get so powerful. This interface is the contract that _RxImpl<T> uses in all it's subclass.
RxList<E>
Create a list similar to List<T>
RxMap<K, V>
Rxn<T>
RxnBool
RxnDouble
RxnInt
RxnNum
RxNotifier<T>
RxnString
Rx class for String Type.
RxNum
RxSet<E>
RxString
Rx class for String Type.
SenderWidget
Socket
SocketNotifier
State<T extends StatefulWidget>
StatefulElement
StatefulWidget
StatelessElement
StatelessWidget
StatusCode
Text
TokenUtil
TrustedCertificate
TypeAdapter<T>
Type adapters can be implemented to support non primitive values.
TypeRegistry
TypeRegistries contain the TypeAdapters associated with a typeId.
UniqueKey
A key that is only equal to itself.
ValueKey<T>
A key that uses a value of a particular type to identify itself.
VirtualDirectory
A VirtualDirectory can serve files and directory-listing from a root path, to HttpRequests.
Visibility
Widget
WidgetBuilder
WidgetEmpty
WidgetResponse
Worker
Workers

Enums

ConnectionState
HiveStorageBackendPreference
declares the preferred JS StorageBackend to be used
Method
SmartManagement
GetX by default disposes unused controllers from memory, Through different behaviors. SmartManagement.full SmartManagement.full is the default one. Dispose classes that are not being used and were not set to be permanent. In the majority of the cases you will want to keep this config untouched. If you new to GetX then don't change this. SmartManagement.onlyBuilders only controllers started in init: or loaded into a Binding with Get.lazyPut() will be disposed. If you use Get.put() or Get.putAsync() or any other approach, SmartManagement will not have permissions to exclude this dependency. With the default behavior, even widgets instantiated with "Get.put" will be removed, unlike SmartManagement.onlyBuilders. SmartManagement.keepFactoryJust like SmartManagement.full, it will remove it's dependencies when it's not being used anymore. However, it will keep their factory, which means it will recreate the dependency if you need that instance again.

Mixins

GetLifeCycleBase
The GetLifeCycle
GetxServiceMixin
Allow track difference between GetxServices and GetxControllers
HiveObjectMixin
Extend HiveObject to add useful methods to the objects you want to store in Hive
NodeMode
NotifyManager<T>
RxObjectMixin<T>
global object that registers against GetX and Obx, and allows the reactivity of those Widgets and Rx values.

Properties

fs → _FSImpl
final
Get → _GetImpl
final
Hive → HiveInterface
Global constant to access Hive.
final

Functions

bodyBytesToString(Stream<List<int>> bodyBytes, Map<String, String> headers) → Future<String>
debounce<T>(RxInterface<T> listener, WorkerCallback<T> callback, {Duration? time, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
debounce is similar to interval, but sends the last value. Useful for Anti DDos, every time the user stops typing for 1 second, for instance. When listener emits the last "value", when time hits, it calls callback with the last "value" emitted.
defaultLogWriterCallback(String value, {bool isError = false}) → void
enumValueToString(Object o) → String
ever<T>(RxInterface<T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Called every time listener changes. As long as the condition returns true.
everAll(List<RxInterface> listeners, WorkerCallback callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Similar to ever, but takes a list of listeners, the condition for the callback is common to all listeners, and the callback is executed to each one of them. The Worker is common to all, so worker.dispose() will cancel all streams.
hashList(Iterable<Object?>? arguments) → int
Combine the Object.hashCode values of an arbitrary number of objects from an Iterable into one value. This function will return the same value if given null as if given an empty list.
hashValues(Object? arg01, Object? arg02, [Object? arg03 = _hashEnd, Object? arg04 = _hashEnd, Object? arg05 = _hashEnd, Object? arg06 = _hashEnd, Object? arg07 = _hashEnd, Object? arg08 = _hashEnd, Object? arg09 = _hashEnd, Object? arg10 = _hashEnd, Object? arg11 = _hashEnd, Object? arg12 = _hashEnd, Object? arg13 = _hashEnd, Object? arg14 = _hashEnd, Object? arg15 = _hashEnd, Object? arg16 = _hashEnd, Object? arg17 = _hashEnd, Object? arg18 = _hashEnd, Object? arg19 = _hashEnd, Object? arg20 = _hashEnd]) → int
Combine up to twenty objects' hash codes into one value.
interval<T>(RxInterface<T> listener, WorkerCallback<T> callback, {Duration time = const Duration(seconds: 1), dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Ignore all changes in listener during time (1 sec by default) or until condition is met (can be a bool expression or a bool Function()), It brings the 1st "value" since the period of time, so if you click a counter button 3 times in 1 sec, it will show you "1" (after 1 sec of the first press) click counter 3 times in 1 sec, it will show you "4" (after 1 sec) click counter 2 times in 1 sec, it will show you "7" (after 1 sec).
once<T>(RxInterface<T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
once() will execute only 1 time when condition is met and cancel the subscription to the listener stream right after that. condition defines when callback is called, and can be a bool or a bool Function().
runApp(Widget widget) → void
runIsolate(void isol(dynamic _)) → void
shortHash(Object? object) → String

Typedefs

AddSubscription<T> = FutureOr<void> Function(LightSubscription<T> subs)
AsyncInstanceBuilderCallback<S> = Future<S> Function()
AsyncWidgetBuilder<T> = Widget Function(BuildContext context, AsyncSnapshot<T>? snapshot)
BindingBuilderCallback = void Function()
CloseSocket = void Function(Close)
CompactionStrategy = bool Function(int entries, int deletedEntries)
A function which decides when to compact a box.
Decoder<T> = T Function(dynamic data)
Disposer = dynamic Function()
InjectorBuilderCallback<S> = S Function(GetInstance)
InstanceBuilderCallback<S> = S Function()
KeyComparator = int Function(dynamic key1, dynamic key2)
LogWriterCallback = void Function(String text, {bool isError})
Voidcallback from logs
MessageSocket = void Function(dynamic val)
MultiPartBuilder = Widget Function(BuildContext context, MultipartUpload? file)
NodeWidgetCallback = Widget Function(BuildContext ctx)
OpenSocket = void Function(GetSocket socket)
PayloadBuilder = Widget Function(BuildContext context, Map? payload)
PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
Progress = dynamic Function(double percent)
RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
SocketBuilder = void Function(GetSocket socket)
ValueUpdater<T> = T Function()
VoidCallback = void Function()
WidgetBuilderCallback = Widget Function(BuildContext context)
WidgetCallback = Widget Function()
WorkerCallback<T> = dynamic Function(T callback)

Exceptions / Errors

HiveError
An error related to Hive.