formats library

Remote Flutter Widgets - formats only import

This is a subset of the rfw library that only exposes features that do not depend on Flutter.

Specifically, the following APIs are exposed by this library:

For client-side code, import package:rfw/rfw.dart instead.

Classes

AnyEventHandler
Base class for EventHandler and SetStateHandler.
AnyStateReference
Base class for StateReference and BoundStateReference.
ArgsReference
Unbound reference to arguments.
BlobNode
Base class of nodes that appear in the output of decodeDataBlob and decodeLibraryBlob.
BoundArgsReference
Bound reference to arguments.
BoundLoopReference
Bound reference to a Loop.
BoundStateReference
Bound reference to a remote widget's state.
ConstructorCall
Representation of references to widgets in Remote Flutter Widgets library blobs.
DataReference
Reference to the DynamicContent data that is passed into the widget (see Runtime.build's data argument).
EventHandler
Description of a callback in an RFW widget declaration.
FullyQualifiedWidgetName
The name of a widget used by the RFW package, including its library name.
Import
A library import.
LibraryName
The name of a widgets library in the RFW package.
Loop
Representation of the ...for construct in Remote Flutter Widgets library blobs.
LoopReference
Unbound reference to a Loop.
Missing
The type of the missing value.
Reference
Base class for various kinds of references in the RFW data structures.
RemoteWidgetLibrary
The in-memory representation of the output of parseTextLibraryFile or decodeLibraryBlob.
SetStateHandler
Description of a state setter in an RFW widget declaration.
SourceLocation
Reference to a location in a source file.
SourceRange
Reference to a range of a source file.
StateReference
Unbound reference to remote widget's state.
Switch
Representation of the switch construct in Remote Flutter Widgets library blobs.
WidgetBuilderArgReference
Reference to the single argument of type DynamicMap passed into the widget builder.
WidgetBuilderDeclaration
Representation of functions that return widgets in Remote Flutter Widgets library blobs.
WidgetDeclaration
A description of a widget in a remote widget library.
WidgetLibrary
Base class for widget libraries.

Constants

dataBlobSignature → const List<int>
The first four bytes of a Remote Flutter Widgets binary data blob.
libraryBlobSignature → const List<int>
The first four bytes of a Remote Flutter Widgets binary library blob.
missing → const Missing
The value used by DynamicContent to represent missing data.

Functions

decodeDataBlob(Uint8List bytes) Object
Decode a Remote Flutter Widgets binary data blob.
decodeLibraryBlob(Uint8List bytes) RemoteWidgetLibrary
Decode a Remote Flutter Widgets binary library blob.
encodeDataBlob(Object value) Uint8List
Encode data as a Remote Flutter Widgets binary data blob.
encodeLibraryBlob(RemoteWidgetLibrary value) Uint8List
Encode data as a Remote Flutter Widgets binary library blob.
parseDataFile(String file) DynamicMap
Parse a Remote Flutter Widgets text data file.
parseLibraryFile(String file, {Object? sourceIdentifier}) RemoteWidgetLibrary
Parses a Remote Flutter Widgets text library file.

Typedefs

DynamicList = List<Object?>
A list whose values are DynamicMap, DynamicList, int, double, bool, string, and BlobNode objects.
DynamicMap = Map<String, Object?>
A map whose keys are strings and whose values are DynamicMap, DynamicList, int, double, bool, string, and BlobNode objects.

Exceptions / Errors

ParserException
Indicates that there an error was detected while parsing a file.