bones_api_server library
Bones_API Server Library.
Classes
- AlterTableSQL
-
A
ALTER TABLE
SQL builder. - APIAuthentication
- APIConfig
- The API Configuration.
- APICredential
- Represents a authentication credential.
- APIDBModule
- APIEntityAccessRules
- Defines an EntityAccessRules for a route.
- APIEntityResolutionRules
- Defines an EntityResolutionRules for a route.
- APIEntityRules
- Defines an EntityResolutionRules for a route.
- APIHotReload
- Hot Reload handler.
- APIMetric
- An API metric.
- APIMetricSet
- Base class for an APIMetric set.
- APIModule
- A module of an API.
- APIModuleInfo
- The APIModule information.
- APIModuleProxy
- A ClassProxy annotation for proxies on APIModule classes.
-
APIModuleProxyCaller<
T> - A APIModuleProxy caller for a specific module (moduleName).
-
APIModuleProxyCallerListener<
T> -
APIModuleProxyDirectCaller<
T> - An APIModuleProxy caller with direct calls to an api instance, for a specific module (moduleName).
-
APIModuleProxyHttpCaller<
T> - An APIModuleProxy caller that performs HTTP requests. Implements a ClassProxyListener that redirects calls to httpClient.
- APIPassword
- APIPasswordHashAlgorithm
- Base class for password hashing.
- APIPasswordNotHashed
- Password without hashing. This is marked as Deprecated to indicate to not use in production!
- APIPasswordSHA256
-
Password hashing using
SHA-256
. - APIPermission
- APIPlatform
- The current API platform.
- APIPlatformCapability
-
APIRepository<
O extends Object> - A entity repository API.
- APIRequest
- Represents an API request.
-
APIResponse<
T> - Represents an API response.
- APIRoot
- Root class of an API.
- APIRootInfo
- The APIRoot information.
-
APIRootStarter<
A extends APIRoot> - Helper to gracefully start/stop an APIRoot.
- APIRouteAuthenticatedRule
- A route rule for access only for authenticated requests (APIAuthentication).
-
APIRouteBuilder<
M extends APIModule> - A route builder.
- APIRouteConfig
- An API route config.
-
APIRouteHandler<
T> - A route handler, with its function and rules.
- APIRouteInfo
- A route information.
- APIRouteNotAuthenticatedRule
- A route rule for access only for NOT authenticated requests.
- APIRoutePermissionTypeRule
- A route rule for access only for authenticated requests with the required permissions (APIAuthentication.permissions).
- APIRoutePublicRule
- A route rule for public access.
- APIRouteRule
- A route rule.
- APISecurity
- APIServer
- An API HTTP Server
- APIServerConfig
- API Server Config.
- APIServerWorker
- APISession
- An APIRoot session. Used by APISecurity.
- APISessionSet
- Handles a set of APISession.
- APIToken
- APITokenStore
- The tokens store for the APISecurity.
- Arguments
-
BasicFieldReflection<
O, T> - A class field reflection.
- BonesAPI
- Bones API Library class.
- CacheControl
- A cache control response.
- ClassProxy
- Informs that a class will be a proxy to a target class with className, without directly depending on the target class.
-
ClassProxyDelegateListener<
T> - A ClassProxyListener that delegates to targetListener.
-
ClassProxyListener<
T> - Interface that a proxy class (annotated with ClassProxy) should implement to list for proxy calls.
-
ClassReflection<
O> - Base for Class reflection.
-
ClassReflectionEntityHandler<
O> -
Completer<
T> - A way to produce Future objects and to complete them later with a value or error.
-
Condition<
O> -
ConditionANY<
O> - ConditionElement
- ConditionEncoder
- Base class to encode Condition.
- ConditionGrammarDefinition
- Condition grammar definition.
-
ConditionID<
O> -
ConditionIdIN<
O> - ConditionKey
- ConditionKeyField
- ConditionKeyIndex
- ConditionParameter
-
ConditionParseCache<
O> - ConditionParser
-
ConditionQuery<
O> - ConditionSQLEncoder
- A Condition encoder for SQL.
-
ConstructorReflection<
O> - CreateIndexSQL
-
A
CREATE INDEX
SQL builder. - CreateTableSQL
-
A
CREATE TABLE
SQL builder. - DataURLBase64
- Represent a Data URL in Base-64
-
DBAdapter<
C extends Object> - Base class for DB adapters.
- DBAdapterCapability
- DBAdapter capabilities.
-
DBAdapterRegister<
C extends Object, A extends DBAdapter< C> > - DBAdapter register. Handles the implementation of:
-
DBConnectionWrapper<
C extends Object> - Base class for a DBAdapter connection.
- DBDialect
-
DBEntityRepository<
O extends Object> -
DBEntityRepositoryProvider<
A extends DBAdapter< Object> > - Base class for EntityRepositoryProvider with DBAdapters.
- DBObjectMemoryAdapter
-
A
DBObjectAdapter
that stores objects in memory. - DBObjectMemoryAdapterContext
-
DBRelationalAdapter<
C extends Object> - Base class for Relational DB adapters.
-
DBRelationalEntityRepository<
O extends Object> -
DBRelationalEntityRepositoryProvider<
A extends DBRelationalAdapter< Object> > - Base class for EntityRepositoryProvider with DBRelationalAdapters.
-
DBRelationalRepositoryAdapter<
O> - An adapter for EntityRepository and DBRelationalAdapter.
-
DBRepositoryAdapter<
O> - An adapter for EntityRepository and DBAdapter.
-
DBSQLAdapter<
C extends Object> - Base class for SQL DB adapters.
- DBSQLAdapterCapability
- DBSQLAdapter capabilities.
-
DBSQLEntityRepository<
O extends Object> -
DBSQLEntityRepositoryProvider<
A extends DBSQLAdapter< Object> > - Base class for EntityRepositoryProvider with DBSQLAdapters.
- DBSQLMemoryAdapter
- A DBSQLAdapter that stores tables data in memory.
- DBSQLMemoryAdapterContext
-
DBSQLRepositoryAdapter<
O> - An adapter for EntityRepository and DBSQLAdapter.
-
ElementReflection<
O> - Base for element reflection.
-
ElementResolver<
T> -
A simple element of type
T
resolver. - EnableReflection
- Enables reflection for a class.
- EncodingContext
- An encoding context for ConditionEncoder.
-
EncodingPlaceholder<
E> -
EncodingPlaceholderIndex<
E> -
EncodingValue<
E, T extends EncodingValue< E, T> > -
EncodingValueList<
E> -
EncodingValueNull<
E> -
EncodingValuePrimitive<
E, T> -
EncodingValueResolved<
E, T extends EncodingValueResolved< E, T> > -
EncodingValueText<
E> - Entity
-
EntityAccessor<
O extends Object> - EntityAccessRules
- Rules to access entities. Used by APIServer responses.
- EntityAccessRulesCached
- An EntityAccessRules with cache for some calls.
- EntityAccessRulesContext
- An EntityAccessRules context passed to rules with a condition (EntityAccessRulesCondition).
- EntityAnnotation
- EntityField
- Configuration of a entity field.
-
EntityFieldAccessorGeneric<
O> -
EntityHandler<
O> - Base class to implement entities handlers.
- EntityHandlerProvider
-
EntityInstantiator<
T> -
EntityInstantiatorHandler<
T> -
EntityMatcher<
O> - EntityProvider
- Entity provider interface.
-
EntityReference<
T> - Reference wrapper to an entity.
-
EntityReferenceBase<
T> - Base class for EntityReference and EntityReferenceList.
-
EntityReferenceList<
T> - Reference wrapper to an entity List.
-
EntityRepository<
O extends Object> - EntityRepositoryProvider
- EntityResolutionRules
- Rules to resolve entities. Used by EntityHandler and DBEntityRepository.
- EntityResolutionRulesResolved
-
EntityRules<
R extends EntityRules< R> > - EntityRulesContextProvider
- An entity rules context provider.
-
EntitySource<
O extends Object> -
EntityStorage<
O extends Object> -
EnumReflection<
O> - Base for Enum reflection.
- Etag
-
A
Etag
of a file/payload identification. See WeakEtag and StrongEtag. -
EventSink<
T> - A Sink that supports adding errors.
- FieldNameMapper
- A KeyMapper for class fields or table columns.
-
FieldReflection<
O, T> - A class field reflection.
-
FunctionReflection<
O, R> - Base class for methods.
-
Future<
T> - The result of an asynchronous computation.
-
FutureOr<
T> -
A type representing values that are either
Future<T>
orT
. -
GenericEntityHandler<
O extends Entity> -
GroupCondition<
O> -
GroupConditionAND<
O> -
GroupConditionOR<
O> - HTMLDocument
- Helper class to generate HTML documents.
- HTMLInput
- An HTML input used by HTMLDocument.
-
IdenticalSet<
O> - A set that matches elements by identical function only.
- IgnoreClassProxyMethod
- InitializationResult
- The initialization result of a Initializable instance.
- InitializationStatus
- The initialization status of the initializable instance.
-
InstanceTracker<
O extends Object, I extends Object> - Tracks an instance with a info relationship.
- IterableClassification
- Iterable elements classification. See EntityHandler.classifyIterableElements
-
IterableEntityRepository<
O extends Object> - Json
- JSON utility class.
- JsonAnnotation
- JsonCodec
- JSON codec integrated with ReflectionFactory.
- JsonConstructor
- Indicates the constructor to be used to instantiate an entity from JSON/Map.
-
JsonConverter<
S, T> - JSON decoder integrated with ReflectionFactory.
- JsonDecoder
- A JSON decoder.
- JsonEncoder
- A JSON encoder.
- JsonEntityCache
- A JSON entity encoding/decoding cache.
- JsonEntityCacheSimple
- Simple implementation of JsonEntityCache.
- JsonField
-
Informs that a class field can be hidden
JsonField.hidden
or visible JsonField.visible - JsonFieldAlias
- Defines the JSON field name.
- JsonGrammarDefinition
- JSON grammar definition.
- JsonGrammarLexer
- JSON grammar lexer.
- JsonParser
-
KeyCondition<
O, V> -
KeyConditionEQ<
O> -
KeyConditionGreaterThan<
O> -
KeyConditionGreaterThanOrEqual<
O> -
KeyConditionIN<
O> -
KeyConditionINBase<
O> -
KeyConditionLessThan<
O> -
KeyConditionLessThanOrEqual<
O> -
KeyConditionNotEQ<
O> -
KeyConditionNotIN<
O> - KeyConditionValue
-
KeyMapper<
K> - Base class for key normalization mapping.
-
MethodInvocation<
T> - Represents a method invocation parameters.
-
MethodReflection<
O, R> - A class method reflection.
- MimeType
- Represents MIME-Type. Useful for Content-Type and file handling.
- MultipleSQL
- Class to wrap multiple SQLs.
-
MultiStreamController<
T> - An enhanced stream controller provided by Stream.multi.
- ParameterReflection
- A parameter reflection, used method arguments or class fields.
- PositionalFields
- Helper to work with positional fields.
- RecursiveToString
- Class with a recursive/complex toString. Use this interface to avoid StackOverflowError on complex toString.
-
Reflection<
O> - Base for reflection.
- ReflectionBridge
- Indicates that a class is a reflection bridge of Types in classesTypes List.
- ReflectionFactory
- Class with all registered reflections (ClassReflection).
- SchemeProvider
- Base class for TableScheme providers.
- SecureRandom
-
SetEntityRepository<
O extends Object> - SQL
- An encoded SQL representation. This is used by a DBSQLAdapter to execute queries.
- SQLBuilder
- Base class for SQL builders
- SQLColumn
- A column information of a SQLEntry.
- SQLDialect
- SQLEntry
- A generic entry in a SQLBuilder.
- SQLGenerator
-
Base class for a
SQL
generator. - SQLWrapper
- SQL wrapper interface.
-
StaticFieldReflection<
O, T> - A class static-field reflection. Extends FieldReflection.
-
StaticFunctionReflection<
O, R> - Base class for static methods and constructors.
-
StaticMethodReflection<
O, R> - A class static-method reflection.
-
Stream<
T> - A source of asynchronous data events.
-
StreamConsumer<
S> - Abstract interface for a "sink" accepting multiple entire streams.
-
StreamController<
T> - A controller with the stream it controls.
-
StreamIterator<
T> - An Iterator-like interface for the values of a Stream.
-
StreamSink<
S> - A object that accepts stream events both synchronously and asynchronously.
-
StreamSubscription<
T> - A subscription on events from a Stream.
-
StreamTransformer<
S, T> - Transforms a Stream.
-
StreamTransformerBase<
S, T> - Base class for implementing StreamTransformer.
-
StreamView<
T> - Stream wrapper that only exposes the Stream interface.
- StringUtils
- Basic String functions.
- StrongEtag
- A strong Etag, that fully identifies the file/payload bytes.
-
SynchronousStreamController<
T> - A stream controller that delivers its events synchronously.
- TableConstraint
- Base class for table constraints.
- TableEnumConstraint
- Table enum field constraint.
- TableFieldReference
- A field that is a reference to another table field.
- TablePrimaryKeyConstraint
- Table primary key field constraint.
- TableRelationshipReference
- A relationship table between two tables.
- TableScheme
- A generic table scheme.
- TableSQL
-
A base class for
CREATE
andALTER
table SQLs. - TableUniqueConstraint
- Unique field constraint.
- Target
- An annotation used on classes that are intended to be used as annotations to indicate the kinds of declarations and directives for which the annotation is appropriate.
- TargetKind
- An enumeration of the kinds of targets to which an annotation can be applied.
- Time
- A Time represents the time of the day, independently of the day of the year, timezone or DateTime.
-
TimedMap<
K, V> - A Map where the keys have a put time (DateTime) and also can expire.
- Timer
- A countdown timer that can be configured to fire once or repeatedly.
- Transaction
- An EntityRepository transaction.
- TransactionEntityProvider
- TransactionOperation
-
TransactionOperationConstrainRelationship<
O, E> -
TransactionOperationCount<
O> -
TransactionOperationDelete<
O> -
TransactionOperationSaveEntity<
O> -
TransactionOperationSelect<
O> -
TransactionOperationSelectRelationship<
O> -
TransactionOperationSelectRelationships<
O> -
TransactionOperationStore<
O> -
TransactionOperationStoreRelationship<
O, E> -
TransactionOperationSubTransaction<
O> -
TransactionOperationUpdate<
O> -
TransactionOperationWithEntity<
O> - TypeEquality
- TypeEquivalency
-
TypeInfo<
T> - Represents a Type and its arguments.
- TypeInfoEquality
- TypeInfoEquivalency
- TypeInfoListEquality
- TypeInfoListEquivalency
- TypeListEquality
- TypeParser
- Lenient parsers for basic Dart types.
-
TypeReflection<
T> - Dart Type reflection.
- Version
- A parsed semantic version number.
- VersionConstraint
- A VersionConstraint is a predicate that can determine whether a given version is valid or not.
- VersionRange
- Constrains versions to a fall within a given range.
- VersionUnion
- A version constraint representing a union of multiple disjoint version ranges.
- WeakEtag
- A weak Etag, that identifies the file/payload allowing tag collisions, but easy to generate.
-
WeakList<
E extends Object> - A List that stores elements using WeakReference.
- WithRuntimeTypeNameSafe
- Interface for classes that need a safe runtimeType as String.
- Zone
- A zone represents an environment that remains stable across asynchronous calls.
- ZoneDelegate
- An adapted view of the parent zone.
-
ZoneField<
T extends Object> -
A field value based in Zones.
This is similar to
ThreadLocal
in Java, but based in the current Zone or a passed contextZone. - ZoneSpecification
- A parameter object with custom zone function handlers for Zone.fork.
Enums
- APIPlatformType
- APIRequesterSource
- APIRequestMethod
- API Methods
- APIResponseStatus
- An APIResponse status.
- BasicDartType
- CacheControlDirective
- A CacheControl directive.
- EntityAccessRuleType
- An EntityAccessRules type.
- TransactionOperationType
Mixins
- APIPayload
- Base class for payload.
-
EntityFieldAccessor<
O> - EntityRulesResolver
- Mixin to resolve the EntityResolutionRules to apply.
- Initializable
Extensions
- APIEntityObjectExtension on Object?
- Extension for entity Objects.
- APIEntityTypeExtension on Type
- Extension for entity Types.
- APIEntityTypeNullableExtension on Type?
- Extension for entity Types.
- APIPlatformTypeExtension on APIPlatformType
- APIRequesterSourceExtension on APIRequesterSource
- APIRequestMethodExtension on APIRequestMethod
- Extension of enum APIRequestMethod.
-
APITokenExtension
on List<
APIToken> -
ClassReflectionExtension
on ClassReflection<
O> - ClassReflection extension.
- DateTimeToTimeExtension on DateTime
- DBExceptionExtension on DBException
-
EntityRepositoryDBExtension
on EntityRepository<
Object> - EntityRepositoryProviderExtension on EntityRepositoryProvider
- ErrorZoneExtension on Zone
- ExtensionRuntimeTypeNameUnsafe on Object?
-
FutureAPIResponseExtension
on Future<
APIResponse< T> > -
FutureExtensions
on Future<
T> - Convenience methods on futures.
-
FutureIterable
on Iterable<
Future< T> > -
FutureOrAPIResponseExtension
on FutureOr<
APIResponse< T> > -
FutureRecord2
on (Future<
T1> , Future<T2> ) - Parallel operations on a record of futures.
-
FutureRecord3
on (Future<
T1> , Future<T2> , Future<T3> ) - Parallel operations on a record of futures.
-
FutureRecord4
on (Future<
T1> , Future<T2> , Future<T3> , Future<T4> ) - Parallel operations on a record of futures.
-
FutureRecord5
on (Future<
T1> , Future<T2> , Future<T3> , Future<T4> , Future<T5> ) - Parallel operations on a record of futures.
-
FutureRecord6
on (Future<
T1> , Future<T2> , Future<T3> , Future<T4> , Future<T5> , Future<T6> ) - Parallel operations on a record of futures.
-
FutureRecord7
on (Future<
T1> , Future<T2> , Future<T3> , Future<T4> , Future<T5> , Future<T6> , Future<T7> ) - Parallel operations on a record of futures.
-
FutureRecord8
on (Future<
T1> , Future<T2> , Future<T3> , Future<T4> , Future<T5> , Future<T6> , Future<T7> , Future<T8> ) - Parallel operations on a record of futures.
-
FutureRecord9
on (Future<
T1> , Future<T2> , Future<T3> , Future<T4> , Future<T5> , Future<T6> , Future<T7> , Future<T8> , Future<T9> ) - Parallel operations on a record of futures.
- GenericObjectExtension on Object?
- Extension for Object nullable.
-
InitializableListExtension
on List<
T> -
IterableEntityAnnotationExtension
on Iterable<
EntityAnnotation> -
IterableEntityFieldExtension
on Iterable<
EntityField> -
IterableEntityReferenceBaseExtension
on Iterable<
EntityReferenceBase< T> > -
IterableEntityReferenceExtension
on Iterable<
EntityReference< T> > -
IterableEntityReferenceListExtension
on Iterable<
EntityReferenceList< T> > -
IterableEntityRepositoryProviderExtension
on Iterable<
EntityRepositoryProvider> -
IterableEnumExtension
on Iterable<
E> - Extension on Iterable of Enum.
-
IterableFieldReflectionExtension
on Iterable<
BasicFieldReflection< O, T> > - FieldReflection extension.
-
IterableJsonFieldAliasExtension
on Iterable<
JsonFieldAlias> -
IterableJsonFieldExtension
on Iterable<
JsonField> -
IterableMethodReflectionExtension
on Iterable<
FunctionReflection< O, R> > - MethodReflection extension.
-
IterableOfIterableEntityReferenceListExtension
on Iterable<
Iterable< EntityReferenceList< >T> > -
IterableParameterReflectionExtension
on Iterable<
ParameterReflection> - FieldReflection extension.
-
IterableTableConstraintExtension
on Iterable<
TableConstraint> -
IterableTypeReflectionExtension
on Iterable<
TypeReflection> - TypeReflection extension.
- JsonEntityCacheExtension on JsonEntityCache
-
ListEntityRepositoryProviderExtension
on List<
EntityRepositoryProvider> -
ListOfStringExtension
on List<
String> - Extension for List of Strings.
-
MapAsCacheExtension
on Map<
K, V> - Extension that ads cached methods to a Map.
-
MapGetterExtension
on Map<
K, V> - Extension for Map to get key values.
-
MapMultiValueExtension
on Map<
K, Object> -
Extension for a multi-value Map: keys as String and values as
String
orList<String>
. -
MapOfCachesExtension
on Map<
C, Map< K, V> > -
MethodReflectionExtension
on MethodReflection<
O, R> - MethodReflection extension.
- MimeTypeResolverExtension on MimeTypeResolver
-
NullEntityReferenceBaseExtension
on EntityReferenceBase<
T> ? -
NullEntityReferenceExtension
on EntityReference<
T> ? -
NullEntityReferenceListExtension
on EntityReferenceList<
T> ? -
PopulateMultiCacheExtension
on Future<
V> -
PopulateMultiCacheNullableExtension
on Future<
V?> - RandomExtension on Random
- RecordExtension on Record
- ReflectionDurationExtension on Duration
- ReflectionFactoryExtension on ReflectionFactory
- ReflectionFactory extension.
-
SetEntityRepositoryProviderExtension
on Set<
EntityRepositoryProvider> -
SQLBuilderIterableMapEntryExtension
on Iterable<
MapEntry< K, CreateTableSQL> > -
SQLBuilderListExtension
on List<
SQLBuilder> -
SQLBuilderMapExtension
on Map<
K, CreateTableSQL> - TransactionOperationTypeExtension on TransactionOperationType
- TypeExtension on Type
- Extension for Type.
-
TypeInfoEntityExtension
on TypeInfo<
T> - Extension over TypeInfo for entity functionalities.
-
TypeReflectionEntityExtension
on TypeReflection<
T> - Extension over TypeReflection for entity functionalities.
Constants
- absentParameterValue → const Object
- absentParameterValueRequired → const Object
-
jsonEscapeChars
→ const Map<
String, String> -
jsonEscapeChars2
→ const Map<
String, String> - unresolvedParameterValue → const Object
- unresolvedParameterValueRequired → const Object
Properties
- jsonEscapeCharsString → String
-
final
- jsonEscapeCharsString2 → String
-
final
- jsonMimeTypeResolver → MimeTypeResolver
-
final
Functions
-
castListType<
T> (List list, Type type) → List -
castMapType<
K, V> (Map map, Type keyType, Type valueType) → Map -
createErrorZone(
{String uncaughtErrorTitle = 'Unhandled exception:', bool printErrorToStderr = true, OnUncaughtError? onUncaughtError, Zone? parentZone}) → Zone - Creates an error Zone.
-
decodeQueryStringParameters(
String? queryString, {String? charset}) → Map< String, dynamic> -
Decodes
queryString
, allowing single and multiple values per key. -
deepCopy<
T> (T? o) → T? -
Deeply copies
o
. -
deepCopyList<
T> (List< T> ? list) → List<T> ? -
Deeply copies
list
. -
deepCopyMap<
K, V> (Map< K, V> ? map) → Map<K, V> ? -
Deeply copies
map
. -
deepCopySet<
T> (Set< T> ? set) → Set<T> ? -
Deeply copies
list
. -
enumFromName<
E extends Enum> (String? name, Iterable< E> enumValues) → E? -
Returns an Enum from
enumValues
that matchesname
. -
enumToName(
Enum enumValue) → String - Returns an Enum name.
-
getURL(
String url, {HttpClient? client, String? method}) → Future< HttpResponse> -
getURLAsByteArray(
String url, {HttpClient? client, String? method}) → FutureOr< List< int> ?> -
getURLAsString(
String url, {HttpClient? client, String? method}) → FutureOr< String?> -
intersectsIterableDeep(
Iterable? it1, Iterable? it2, {ValueEquality? valueEquality}) → bool -
isEqualsDeep(
Object? o1, Object? o2, {ValueEquality? valueEquality}) → bool -
Returns
true
ifo1
ando2
are equals deeply. -
isEqualsIterableDeep(
Iterable? it1, Iterable? it2, {ValueEquality? valueEquality}) → bool - Same as isEqualsListDeep but for Iterable.
-
isEqualsListDeep(
List? l1, List? l2, {ValueEquality? valueEquality}) → bool -
Returns
true
ifl1
andl2
are equals deeply (including values tree equality). -
isEqualsMapDeep(
Map? m1, Map? m2, {ValueEquality? valueEquality}) → bool -
Returns
true
ifm1
andm2
are equals deeply (including values tree equality). -
isEqualsSetDeep(
Set? set1, Set? set2, {ValueEquality? valueEquality}) → bool - Same as isEqualsListDeep but for Set.
-
parseAPIRequestMethod(
String? method) → APIRequestMethod? -
Returns the APIRequestMethod for
method
. -
parseAPIResponseStatus(
Object o) → APIResponseStatus? - Parses a APIResponseStatus.
-
printToZoneStderr(
Object? o) → void -
Similar to print but prints to
STDERR
. -
printZoneError(
Object error, StackTrace stackTrace, {String? title, String? message, bool printErrorToStderr = true}) → void -
Prints an
error
andstackTrace
. -
runZoned<
R> (R body(), {Map< Object?, Object?> ? zoneValues, ZoneSpecification? zoneSpecification, Function? onError}) → R -
Runs
body
in its own zone. -
runZonedGuarded<
R> (R body(), void onError(Object error, StackTrace stack), {Map< Object?, Object?> ? zoneValues, ZoneSpecification? zoneSpecification}) → R? -
Runs
body
in its own error zone. -
scheduleMicrotask(
void callback()) → void - Runs a function asynchronously.
-
tryCall<
T> (FutureOr< T?> call(), {T? defaultValue, T? onSuccessValue, T? onErrorValue}) → FutureOr<T?> -
Tries to performa a
call
. -
tryCallMapped<
T, R> (FutureOr< T?> call(), {R? defaultValue, R? onSuccessValue, R? onSuccess(T? value)?, R? onErrorValue, R? onError(Object error, StackTrace s)?}) → FutureOr<R?> -
Tries to performa a
call
. See tryCall. -
tryCallSync<
T> (T? call(), {T? defaultValue, T? onSuccessValue, T? onErrorValue}) → T? -
Tries to performa a
call
synchronously. -
tryParseDuration(
String? v, [Duration? def]) → Duration? -
unawaited(
Future< void> ? future) → void - Explicitly ignores a future.
Typedefs
-
APIConfigProvider
= FutureOr<
APIConfig?> Function() - APILogger = void Function(APIRoot apiRoot, String type, String? message, [Object? error, StackTrace? stackTrace])
- An APIRoot logger function.
-
APIModuleHttpProxyRequestHandler
= FutureOr? Function(APIModuleProxyHttpCaller proxy, String methodName, Map<
String, Object?> parameters) - APIModuleProxyResponseErrorHandler = void Function(APIModuleProxyCallerResponseError responseError)
-
APIModuleProxyTargetResolver
= ClassProxyListener<
T> ? Function<T>(Object target, String? moduleName, bool? responsesAsJson, APIModuleProxyResponseErrorHandler? errorHandler) -
APIRequestHandler
= FutureOr<
APIResponse< Function<T> ?>T>(APIRoot apiRoot, APIRequest request) - An APIRoot APIRequest handler.
-
APIRouteFunction<
T> = FutureOr< APIResponse< Function(APIRequest request)T> > - An API route handler
-
APITokenInfo
= ({APIToken apiToken, Object? data, List<
APIPermission> permissions}) - ConstructorReflectionAccessor = Function Function()
- ControllerCallback = void Function()
-
Type of a stream controller's
onListen
,onPause
andonResume
callbacks. -
ControllerCancelCallback
= FutureOr<
void> Function() -
Type of stream controller
onCancel
callbacks. - CreatePeriodicTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration period, void f(Timer timer))
- The type of a custom Zone.createPeriodicTimer implementation function.
- CreateTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration duration, void f())
- The type of a custom Zone.createTimer implementation function.
-
DBAdapterInstantiator<
C extends Object, A extends DBAdapter< C> > = FutureOr<A?> Function(Map<String, dynamic> config, {int? maxConnections, int? minConnections, EntityRepositoryProvider? parentRepositoryProvider, String? workingPath}) - DBMemoryObjectAdapter = DBObjectMemoryAdapter
- DBMemoryObjectAdapterException = DBObjectMemoryAdapterException
- DBMemorySQLAdapter = DBSQLMemoryAdapter
- DBMemorySQLAdapterException = DBSQLMemoryAdapterException
-
DBSQLAdapterInstantiator<
C extends Object, A extends DBSQLAdapter< C> > = DBAdapterInstantiator<C, A> -
EntitiesFetcher<
T> = FutureOr< List< Function(List<T?> ?>Object?> ids, Type type) - EntityAccessRulesCondition = bool Function(EntityAccessRulesContext? context)
- An EntityAccessRules.condition.
- EntityAccessRulesMasker = Object? Function(EntityAccessRulesContext? context, Object object, String field, Object? value)
- An EntityAccessRules.masker.
- EntityCache = JsonEntityCache
-
EntityFetcher<
T> = FutureOr< T?> Function(Object? id, Type type) - ErrorCallbackHandler = AsyncError? Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace? stackTrace)
- The type of a custom Zone.errorCallback implementation function.
- ErrorFilter = bool Function(Object, StackTrace)
-
ExecuteInitializedCallback<
R> = FutureOr< R> Function() -
FieldGetter<
T> = T Function() -
FieldNameResolver
= String? Function(String field, Map<
String, Object?> map) -
FieldReflectionGetterAccessor<
O, T> = FieldGetter< T> Function(O? obj) -
FieldReflectionSetterAccessor<
O, T> = FieldSetter< T> Function(O? obj) -
FieldSetter<
T> = void Function(T v) - FieldValueResolver = Object? Function(String field, Object? value, TypeReflection type)
-
ForkHandler
= Zone Function(Zone self, ZoneDelegate parent, Zone zone, ZoneSpecification? specification, Map<
Object?, Object?> ? zoneValues) - The type of a custom Zone.fork implementation function.
- HandleUncaughtErrorHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace stackTrace)
- The type of a custom Zone.handleUncaughtError implementation function.
-
InstanceInfoExtractor<
O, I> = I Function(O o) -
InstantiatorDefault<
O> = FutureOr< O> Function() -
InstantiatorFromMap<
O> = FutureOr< O> Function(Map<String, dynamic> ) - IterableCaster = Object? Function(Iterable value, TypeReflection type, JsonDecoder jsonDecoder)
-
JsomMapDecoder<
O> = O? Function(Map< String, Object?> map, JsonDecoder jsonDecoder) -
JsomMapDecoderAsync<
O> = FutureOr< O?> Function(Map<String, Object?> map, JsonDecoder jsonDecoder) -
JsomMapDecoderAsyncProvider
= JsomMapDecoderAsync? Function(Type type, Map<
String, Object?> map, JsonDecoder jsonDecoder) -
JsomMapDecoderProvider
= JsomMapDecoder? Function(Type type, Map<
String, Object?> map, JsonDecoder jsonDecoder) - JsonFieldMatcher = bool Function(String key)
- JsonReviver = Object? Function(Object? key, Object? value)
- JsonToEncodable = Object? Function(dynamic object)
-
JsonTypeDecoder<
T> = T? Function(Object? json, JsonDecoder? jsonDecoder, TypeInfo typeInfo) -
JsonTypeToEncodable<
T> = Object? Function(T object) -
JsonValueDecoder<
O> = O? Function(Object? o, Type type, JsonDecoder jsonDecoder) -
JsonValueDecoderProvider<
O> = JsonValueDecoder< O> ? Function(Type type, Object? value, JsonDecoder jsonDecoder) - MapCaster = Object? Function(Map value, TypeReflection type, JsonDecoder jsonDecoder)
-
MethodReflectionAccessor<
O> = Function Function(O? obj) -
OnConstructorInvocationError
= void Function(ConstructorReflection constructor, MethodInvocation methodInvocation, Map<
String, dynamic> map, Object? error) - OnUncaughtError = void Function(Object error, StackTrace stackTrace)
- ParameterProvider = Object? Function(ParameterReflection parameter, int? parameterIndex)
-
PasswordProvider
= FutureOr<
String> Function(String user) -
PreFinishDBOperation<
T, R> = FutureOr< R> Function(T result) - PrintHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, String line)
- The type of a custom Zone.print implementation function.
-
RegisterBinaryCallbackHandler
= ZoneBinaryCallback<
R, T1, T2> Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2)) - The type of a custom Zone.registerBinaryCallback implementation function.
-
RegisterCallbackHandler
= ZoneCallback<
R> Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f()) - The type of a custom Zone.registerCallback implementation function.
-
RegisterUnaryCallbackHandler
= ZoneUnaryCallback<
R, T> Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg)) - The type of a custom Zone.registerUnaryCallback implementation function.
-
RunBinaryHandler
= R Function<
R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2), T1 arg1, T2 arg2) - The type of a custom Zone.runBinary implementation function.
-
RunHandler
= R Function<
R>(Zone self, ZoneDelegate parent, Zone zone, R f()) - The type of a custom Zone.run implementation function.
-
RunUnaryHandler
= R Function<
R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg), T arg) - The type of a custom Zone.runUnary implementation function.
- ScheduleMicrotaskHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, void f())
- The type of a custom Zone.scheduleMicrotask implementation function.
- SQLBuilderComparator = int Function(SQLBuilder a, SQLBuilder b)
- SQLBuilderSelector = bool Function(SQLBuilder o)
-
StaticFieldReflectionGetterAccessor<
T> = FieldGetter< T> Function() -
StaticFieldReflectionSetterAccessor<
T> = FieldSetter< T> Function() - StaticMethodReflectionAccessor = Function Function()
- ToEncodable = Object? Function(Object? object)
- ToEncodableJson = Object? Function(Object? object, JsonEncoder jsonEncoder)
- ToEncodableJsonProvider = ToEncodableJson? Function(Object object)
- TransactionErrorResolver = Object? Function(Object error, StackTrace stackTrace, Object? operation, Object? previousError)
-
TransactionExecution<
R, C> = FutureOr< R> Function(C context) -
TypeElementParser<
T> = T? Function(Object? o) -
ValueEncoder<
E, P extends EncodingValue< E, P> > = E Function(P parameterValue) - ValueEquality = bool Function(Object v1, Object v2)
-
ZoneBinaryCallback<
R, T1, T2> = R Function(T1, T2) -
ZoneCallback<
R> = R Function() -
ZoneUnaryCallback<
R, T> = R Function(T)
Exceptions / Errors
- APIModuleProxyCallerError
- APIModuleProxyCallerResponseError
- AsyncError
- An error and a stack trace.
- ClassProxyCallError
- A ClassProxy call error.
- ConditionEncodingError
- DBAdapterException
- A DBAdapter Exception.
- DBException
- Base interface for DB Exceptions.
- DBObjectMemoryAdapterException
- Error thrown by DBObjectMemoryAdapter operations.
- DBSQLAdapterException
-
A
SQLAdapter
Exception. - DBSQLMemoryAdapterException
- Error thrown by DBSQLMemoryAdapter operations.
- DeferredLoadException
- Thrown when a deferred library fails to load.
- EntityFieldInvalid
- An entity field validation error.
-
MergeEntityRulesError<
R extends EntityRules< R> > - EntityRules.merge error.
-
ParallelWaitError<
V, E> - Error thrown when waiting for multiple futures, when some have errors.
- RecursiveRelationshipLoopError
- Error thrown when a store of an entity with a recursive relationship loop is detected.
- TimeoutException
- Thrown when a scheduled timeout happens while waiting for an async result.
- TransactionAbortedError
- A Transaction abortion error.
- UnresolvedParameterError
- Error thrown when MethodInvocation can't be defined due to an unresolved parameter value.
-
ValidateEntityRulesError<
R extends EntityRules< R> > - EntityRules.validate error.