LazyMessagePayload class

A payload view that delays decoding until an application reads its values.

The view can retain encoded argument slices or one packed PPT payload while preserving the object that owns the underlying storage through anchor.

Constructors

LazyMessagePayload.encoded({Uint8List? transparentBinaryPayload, LazyPayloadEncoding? encoding, WampE2eeProvider? e2eeProvider, WampE2eeRuntimeContext? e2eeRuntimeContext, Uint8List? argumentsBytes, Uint8List? argumentsKeywordsBytes, PayloadListDecoder? argumentsDecoder, PayloadMapDecoder? argumentsKeywordsDecoder, List? arguments, Map<String, dynamic>? argumentsKeywords, Object? anchor})
Creates a view backed by separately encoded positional and keyword data.
factory
LazyMessagePayload.materialized({Uint8List? transparentBinaryPayload, LazyPayloadEncoding? encoding, List? arguments, Map<String, dynamic>? argumentsKeywords, bool pptDecoded = false, WampE2eeProvider? e2eeProvider, WampE2eeRuntimeContext? e2eeRuntimeContext, Object? anchor})
Creates a view from already materialized positional and keyword values.
factory
LazyMessagePayload.packed({Uint8List? transparentBinaryPayload, required LazyPayloadEncoding? encoding, required Uint8List packedPayloadBytes, required PackedPayloadDecoder packedPayloadDecoder, bool pptDecoded = true, WampE2eeProvider? e2eeProvider, WampE2eeRuntimeContext? e2eeRuntimeContext, Object? anchor})
Creates a view backed by one packed Payload Passthru Mode value.
factory

Properties

anchor → Object?
Keeps externally owned encoded storage alive for this view's lifetime.
final
arguments → List?
Positional arguments, decoded on first access when necessary.
no setter
argumentsBytes → Uint8List?
The encoded positional argument slice, when one was retained.
no setter
argumentsKeywords → Map<String, dynamic>?
Keyword arguments, decoded on first access when necessary.
no setter
argumentsKeywordsBytes → Uint8List?
The encoded keyword argument slice, when one was retained.
no setter
e2eeProvider → WampE2eeProvider?
The provider used to decrypt a retained E2EE payload when required.
final
e2eeRuntimeContext → WampE2eeRuntimeContext?
Runtime context associated with an encoded E2EE payload.
final
encoding → LazyPayloadEncoding?
The serializer needed to decode the retained argument bytes.
final
hasEncodedArguments → bool
Whether encoded positional arguments remain available without decoding.
no setter
hasEncodedArgumentsKeywords → bool
Whether encoded keyword arguments remain available without decoding.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasPackedPayloadBytes → bool
Whether this view retains one packed PPT payload.
no setter
packedPayloadBytes → Uint8List?
The packed PPT payload bytes, when available.
no setter
pptDecoded → bool
Whether any PPT or E2EE wrapper has already been removed.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transparentBinaryPayload → Uint8List?
The transparent binary payload carried outside regular WAMP arguments.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toOwned() → LazyMessagePayload
Copies retained buffers and materialized WAMP lists, maps and binary values without forcing decoding. Providers, contexts and decoder callbacks remain shared; the external storage anchor is not retained.
toString() → String
A string representation of this object.
inherited
withAnchor(Object? anchor) → LazyMessagePayload
Returns an equivalent view that retains anchor.
withE2eeProvider(WampE2eeProvider? provider) → LazyMessagePayload
Returns an equivalent view associated with provider.
withE2eeRuntimeContext(WampE2eeRuntimeContext? runtimeContext) → LazyMessagePayload
Returns an equivalent view associated with runtimeContext.

Operators

operator ==(Object other) → bool
The equality operator.
inherited