flutter_rust_bridge_for_generated_web library
This is only intended to be used by automatically generated code, instead of developers.
Classes
- BaseApi
- This is only intended to be used by automatically generated code, instead of developers.
-
BaseApiImpl<
W extends BaseWire> - This is only intended to be used by automatically generated code, instead of developers.
-
BaseEntrypoint<
A extends BaseApi, AI extends BaseApiImpl< BaseWire> , W extends BaseWire> -
This is the main entrypoint.
For example, users call
initon it, and auto-generated code callapion it. - BaseHandler
- Generically handles a Dart-Rust call.
-
BaseTask<
S, E extends Object, WireSyncType> - Base class for various kinds of tasks.
- BaseWire
- This is only intended to be used by automatically generated code, instead of developers.
-
Box<
T> - This is only intended to be used by automatically generated code, instead of developers.
- ByteBuffer
- A sequence of bytes underlying a typed data object.
- ByteData
- A fixed-length, random-access sequence of bytes that also provides random and unaligned access to the fixed-width integers and floating point numbers represented by those bytes.
- BytesBuilder
- Builds a list of bytes, allowing bytes and lists of bytes to be added at the end.
-
CstCodec<
S, E extends Object> - This is only intended to be used by automatically generated code, instead of developers.
-
DcoCodec<
S, E extends Object> - This is only intended to be used by automatically generated code, instead of developers.
- Endian
- Describes endianness to be used when accessing or updating a sequence of bytes.
- ExternalLibrary
- This is only intended to be used by automatically generated code, instead of developers.
- ExternalLibraryLoaderConfig
-
Arguments of
loadExternalLibary - Float32List
- A fixed-length list of IEEE 754 single-precision binary floating-point numbers that is viewable as a TypedData.
- Float32x4
- Float32x4 immutable value type and operations.
- Float32x4List
- A fixed-length list of Float32x4 numbers that is viewable as a TypedData.
- Float64List
- A fixed-length list of IEEE 754 double-precision binary floating-point numbers that is viewable as a TypedData.
- Float64x2
- Float64x2 immutable value type and operations.
- Float64x2List
- A fixed-length list of Float64x2 numbers that is viewable as a TypedData.
-
FutureOr<
T> -
A type representing values that are either
Future<T>orT. - Int16List
- A fixed-length list of 16-bit signed integers that is viewable as a TypedData.
- Int32List
- A fixed-length list of 32-bit signed integers that is viewable as a TypedData.
- Int32x4
- Int32x4 and operations.
- Int32x4List
- A fixed-length list of Int32x4 numbers that is viewable as a TypedData.
- Int64List
- A strict version of $data.Int64List which always returns a BigInt.
- Int8List
- A fixed-length list of 8-bit signed integers.
- JS
- An annotation that indicates a library, class, or member is implemented directly in JavaScript.
- JSExport
-
Annotation to allow Dart classes to be wrapped with a JS object using
dart:js_interop'screateJSInteropWrapper. - Modules
- Currently supported modes of module initialization.
-
NormalTask<
S, E extends Object> - A task to call FFI function.
- PlatformInt64Util
- The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
- PlatformPointerUtil
- The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
-
RustArc<
T> -
The Rust
std::sync::Arcon the Dart side. -
RustArcStaticData<
T> - Should have exactly one instance per type.
- RustOpaque
- An opaque pointer to a native arbitrary Rust type. TODO: link to the doc talking about "dispose"/GC semantics
-
RustStreamSink<
T> -
The Rust
StreamSink<T>on the Dart side. -
SseCodec<
S, E extends Object> - This is only intended to be used by automatically generated code, instead of developers.
- SseDeserializer
- This is only intended to be used by automatically generated code, instead of developers.
- SseSerializer
- This is only intended to be used by automatically generated code, instead of developers.
-
SyncTask<
S, E extends Object, WireSyncType> - A task to call FFI function, but it is synchronous.
- TaskConstMeta
-
Metadata that does not change across different method calls. Thus it is made
constto save memory and speed up - TypedData
- A typed view of a sequence of bytes.
- Uint16List
- A fixed-length list of 16-bit unsigned integers that is viewable as a TypedData.
- Uint32List
- A fixed-length list of 32-bit unsigned integers that is viewable as a TypedData.
- Uint64List
- A strict version of $data.Uint64List which always returns a BigInt.
- Uint8ClampedList
- A fixed-length list of 8-bit unsigned integers.
- Uint8List
- A fixed-length list of 8-bit unsigned integers.
- UnmodifiableByteBufferView
- A read-only view of a ByteBuffer.
- UnmodifiableByteDataView
- A read-only view of a ByteData.
- UnmodifiableFloat32ListView
- View of a Float32List that disallows modification.
- UnmodifiableFloat32x4ListView
- View of a Float32x4List that disallows modification.
- UnmodifiableFloat64ListView
- View of a Float64List that disallows modification.
- UnmodifiableFloat64x2ListView
- View of a Float64x2List that disallows modification.
- UnmodifiableInt16ListView
- View of a Int16List that disallows modification.
- UnmodifiableInt32ListView
- View of a Int32List that disallows modification.
- UnmodifiableInt32x4ListView
- View of a Int32x4List that disallows modification.
- UnmodifiableInt64ListView
- View of a Int64List that disallows modification.
- UnmodifiableInt8ListView
- View of a Int8List that disallows modification.
- UnmodifiableUint16ListView
- View of a Uint16List that disallows modification.
- UnmodifiableUint32ListView
- View of a Uint32List that disallows modification.
- UnmodifiableUint64ListView
- View of a Uint64List that disallows modification.
- UnmodifiableUint8ClampedListView
- View of a Uint8ClampedList that disallows modification.
- UnmodifiableUint8ListView
- View of a Uint8List that disallows modification.
- WasmModule
- A JS function that returns a Promise to a WASM module. See this file for an example of how to obtain and initialize this type.
Extensions
- ExtReadBuffer on ReadBuffer
- Extensions for ReadBuffer
- ExtWriteBuffer on WriteBuffer
- Extensions for WriteBuffer
Constants
- anonymous → const _Anonymous
- An annotation that indicates a JS annotated class is structural and does not have a known JavaScript prototype.
- internal → const _Internal
- Used to annotate a declaration which should only be used from within the package in which it is declared, and which should not be exposed from said package's public API.
- protected → const _Protected
- Used to annotate an instance member in a class or mixin which is meant to be visible only within the declaring library, and to other instance members of the class or mixin, and their subtypes.
- sealed → const _Sealed
- Annotation marking a class as not allowed as a super-type outside of the current package.
- staticInterop → const _StaticInterop
- staticInterop enables the JS annotated class to be treated as a "static" interop class.
- trustTypes → const _TrustTypes
Properties
- crossOriginIsolated → bool?
-
Whether the web platform has been isolated by COOP and COEP headers,
and is capable of sharing buffers between workers.
no setter
Functions
-
allowInterop<
F extends Function> (F f) → F -
Returns a wrapper around function
fthat can be called from JavaScript usingpackage:jsJavaScript interop. -
allowInteropCaptureThis(
Function f) → Function -
Returns a wrapper around function
fthat can be called from JavaScript usingpackage:jsJavaScript interop, passing JavaScriptthisas the first argument. -
castInt(
Object? value) → int - This is only intended to be used by automatically generated code, instead of developers.
-
castNativeBigInt(
Object? value) → Object - This is only intended to be used by automatically generated code, instead of developers.
-
dcoDecodeDuration(
int ts) → Duration - This is only intended to be used by automatically generated code, instead of developers.
-
dcoDecodeI64(
dynamic raw) → BigInt - This is only intended to be used by automatically generated code, instead of developers.
-
dcoDecodePanicError(
dynamic raw) → PanicException - This is only intended to be used by automatically generated code, instead of developers.
-
dcoDecodeTimestamp(
{required int ts, required bool isUtc}) → DateTime - This is only intended to be used by automatically generated code, instead of developers.
-
dcoDecodeU64(
dynamic raw) → BigInt - This is only intended to be used by automatically generated code, instead of developers.
-
decodeDartOpaque(
dynamic raw, GeneralizedFrbRustBinding generalizedFrbRustBinding) → Object - This is only intended to be used by automatically generated code, instead of developers.
-
encodeDartOpaque(
Object raw, NativePortType dartHandlerPort, GeneralizedFrbRustBinding generalizedFrbRustBinding) → PlatformPointer - This is only intended to be used by automatically generated code, instead of developers.
-
jsBigIntToDartBigInt(
Object bigInt) → BigInt - This is only intended to be used by automatically generated code, instead of developers.
-
jsConsoleWarn(
[dynamic a, dynamic b, dynamic c, dynamic d, dynamic e, dynamic f, dynamic g, dynamic h, dynamic i]) → void - The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
-
jsEval(
String script) → dynamic - The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
-
loadExternalLibrary(
ExternalLibraryLoaderConfig config) → FutureOr< ExternalLibrary> - Load the ExternalLibrary, with the following cases in mind:
-
pdeCallFfi(
GeneralizedFrbRustBinding generalizedFrbRustBinding, SseSerializer serializer, {required int funcId, NativePortType? port}) → WireSyncRust2DartSse? - This is only intended to be used by automatically generated code, instead of developers.
-
sseDecodePanicError(
SseDeserializer deserializer) → PanicException - This is only intended to be used by automatically generated code, instead of developers.
-
wireSyncRust2DartDcoIntoDart(
WireSyncRust2DartDco syncReturn) → List - The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
-
wireSyncRust2DartSseAsUint8ListView(
WireSyncRust2DartSse raw) → Uint8List - The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
Typedefs
-
ApiImplConstructor<
A extends BaseApiImpl< BaseWire> , W extends BaseWire> = A Function({required GeneralizedFrbRustBinding generalizedFrbRustBinding, required BaseHandler handler, required PortManager portManager, required W wire}) - This is only intended to be used by automatically generated code, instead of developers.
- CrossPlatformFinalizerArg = void Function(PlatformPointer)
- The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
- DartPostCObject = void
- This is only intended to be used by automatically generated code, instead of developers.
- NativePortType = dynamic
- This is only intended to be used by automatically generated code, instead of developers.
- PlatformGeneralizedUint8List = AdaptedUint8List
- The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
- PlatformGeneralizedUint8ListPtr = Uint8List
- The code is used only internally and is not a public API. The comment exists mainly to satisfy the linter.
- PlatformInt64 = BigInt
- This is only intended to be used by automatically generated code, instead of developers.
- PlatformPointer = int
- This is only intended to be used by automatically generated code, instead of developers.
- RustArcDecrementStrongCountFnType = void Function(PlatformPointer)
-
The type of
RustArcStaticData._rustArcDecrementStrongCount - RustArcIncrementStrongCountFnType = void Function(PlatformPointer)
-
The type of
RustArcStaticData._rustArcIncrementStrongCount -
WireConstructor<
W> = W Function(ExternalLibrary externalLibrary) - This is only intended to be used by automatically generated code, instead of developers.
- WireSyncRust2DartDco = List
- This is only intended to be used by automatically generated code, instead of developers.
- WireSyncRust2DartSse = Uint8List
- This is only intended to be used by automatically generated code, instead of developers.
Exceptions / Errors
- AnyhowException
-
The rust code returns
anyhow::Error - FrbBacktracedException
- Interface indicating exceptions that have backtrace (stack trace)
- FrbException
- Base class for exceptions in flutter_rust_bridge
- MissingHeaderException
- Thrown when the browser is not run in a cross-origin isolated environment.
- PanicException
- The rust code is panicked
- PlatformMismatchException
- Platform is not matched
- UnmodifiableTypedListException
- Cannot modify a typed list