easy_downloader library
easy_downloader, A Very Good Project created by Very Good CLI.
# activate easy_downloader
dart pub global activate easy_downloader
# see usage
easy_downloader --help
Classes
- Backlink
- Annotation to create a backlink to an existing link.
- Collection
- Annotation to create an Isar collection.
-
CollectionSchema<
OBJ> - This schema represents a collection.
- CompactCondition
- Isar databases can contain unused space that will be reused for later operations. You can specify conditions to trigger manual compaction where the entire database is copied and unused space freed.
- CompositeIndex
- Another property that is part of the composite index.
- DistinctProperty
- Property used to filter duplicate values.
- DownloadBlock
- class to store download block start start end end id id downloaded downloaded status status currentSplit current split hashCode hash code copyWith copy with toString to string operator == operator == runtimeType runtime type
- DownloadTask
- class to store download task downloadId download id inQueue in queue totalLength total length totalDownloaded total downloaded path path maxSplit max split status status blocks blocks fileName file name headers headers url url outputFilePath output file path hashCode hash code
- EasyDownloader
- EasyDownloader init EasyDownloader example:
- Embedded
- Annotation to nest objects of this type in collections.
- Enumerated
- Annotation to specify how an enum property should be serialized.
- FilterCondition
- Create a filter condition dynamically.
- FilterGroup
- Group one or more filter conditions.
- IdWhereClause
- A where clause traversing the primary index (ids).
- Ignore
- Annotate a property or accessor in an Isar collection to ignore it.
- Index
- Annotate properties to build an index.
- IndexPropertySchema
- This schema represents a composite index property.
- IndexSchema
- This schema represents an index.
- IndexWhereClause
- A where clause traversing an index.
- Isar
- An instance of the Isar Database.
-
IsarCollection<
OBJ> -
Use
IsarCollection
instances to find, query, and create new objects of a given type in Isar. -
IsarLink<
OBJ> - Establishes a 1:1 relationship with the same or another collection. The target collection is specified by the generic type argument.
-
IsarLinks<
OBJ> - Establishes a 1:n relationship with the same or another collection. The target collection is specified by the generic type argument.
- LinkFilter
- Filter condition based on a link.
- LinkSchema
- This schema represents a link to the same or another collection.
- LinkWhereClause
- A where clause traversing objects linked to the specified object.
- Log
-
all logs will be filtered by this class
shouldLog
return true if you want to print log force all logs to be printed - Name
- Annotate Isar collections or properties to change their name.
- ObjectFilter
- Filter condition based on an embedded object.
- PropertySchema
- A single propery of a collection or embedded object.
-
Query<
T> - Querying is how you find records that match certain conditions.
-
QueryBuilder<
OBJ, R, S> - Query builders are used to create queries in a safe way.
-
Schema<
OBJ> - This schema either represents a collection or embedded object.
- SortProperty
- Property used to sort query results.
- WhereClause
- A where clause to traverse an Isar index.
Enums
- BlockStatus
-
The status of a block
downloading downloading
finished finished
failed failed
none
none - DownloadStatus
- The status of a download downloading downloading paused paused completed completed failed failed appending appending queuing queuing none none
- EnumType
- Enum type for enum values.
- FilterConditionType
- The type of dynamic filter conditions.
- FilterGroupType
- The type of filter groups.
- IndexType
- Specifies how an index is stored in Isar.
- IsarType
- Supported Isar types
- Sort
- Sort order
Extensions
-
DownloadBlockQueryFilter
on QueryBuilder<
DownloadBlock, DownloadBlock, QFilterCondition> -
DownloadBlockQueryObject
on QueryBuilder<
DownloadBlock, DownloadBlock, QFilterCondition> -
DownloadTaskQueryFilter
on QueryBuilder<
DownloadTask, DownloadTask, QFilterCondition> -
DownloadTaskQueryLinks
on QueryBuilder<
DownloadTask, DownloadTask, QFilterCondition> -
DownloadTaskQueryObject
on QueryBuilder<
DownloadTask, DownloadTask, QFilterCondition> -
DownloadTaskQueryProperty
on QueryBuilder<
DownloadTask, DownloadTask, QQueryProperty> -
DownloadTaskQuerySortBy
on QueryBuilder<
DownloadTask, DownloadTask, QSortBy> -
DownloadTaskQuerySortThenBy
on QueryBuilder<
DownloadTask, DownloadTask, QSortThenBy> -
DownloadTaskQueryWhere
on QueryBuilder<
DownloadTask, DownloadTask, QWhereClause> -
DownloadTaskQueryWhereDistinct
on QueryBuilder<
DownloadTask, DownloadTask, QDistinct> -
DownloadTaskQueryWhereSort
on QueryBuilder<
DownloadTask, DownloadTask, QWhere> - GetDownloadTaskCollection on Isar
- IntExtension on int
-
convert bytes to human readable string
bytes
bytes return human readable string -
QueryAggregation
on Query<
T?> - Extension for Queries
-
QueryDateAggregation
on Query<
T> - Extension for Queries
-
QueryExecute
on QueryBuilder<
OBJ, R, QQueryOperations> - Extension for QueryBuilders
-
QueryExecuteAggregation
on QueryBuilder<
OBJ, T?, QQueryOperations> - Extension for QueryBuilders
-
QueryExecuteDateAggregation
on QueryBuilder<
OBJ, DateTime?, QQueryOperations> - Extension for QueryBuilders
-
QueryFilterAndOr
on QueryBuilder<
OBJ, R, QFilterOperator> - Extension for QueryBuilders.
-
QueryFilterNoGroups
on QueryBuilder<
OBJ, R, QFilterCondition> - Extension for QueryBuilders.
-
QueryFilterNot
on QueryBuilder<
OBJ, R, QFilterCondition> - Extension for QueryBuilders.
-
QueryFilters
on QueryBuilder<
OBJ, R, QFilter> - Extension for QueryBuilders.
-
QueryLimit
on QueryBuilder<
OBJ, R, QLimit> - Extension for QueryBuilders.
-
QueryModifier
on QueryBuilder<
OBJ, OBJ, S> - Extension for QueryBuilders.
-
QueryOffset
on QueryBuilder<
OBJ, R, QOffset> - Extension for QueryBuilders.
-
QueryWhere
on QueryBuilder<
OBJ, R, QWhereClause> - Extension for QueryBuilders.
-
QueryWhereOr
on QueryBuilder<
OBJ, R, QWhereOr> - Extension for QueryBuilders.
- TaskExtension on DownloadTask
-
helper for DownloadTask
start start task
pause pause task
continueDownload continue task
cancel cancel task
delete delete task
retry
retry taskupdateBlock
update block
Constants
- collection → const Collection
- Annotation to create an Isar collection.
-
DownloadBlockSchema
→ const Schema<
DownloadBlock> -
DownloadTaskSchema
→ const CollectionSchema<
DownloadTask> - embedded → const Embedded
- Annotation to nest objects of this type in collections.
- enumerated → const Enumerated
- Annotation to specify how an enum property should be serialized.
- ignore → const Ignore
- Annotate a property or accessor in an Isar collection to ignore it.
Typedefs
- byte = int
- Type to mark an int property or List as 8-bit sized.
- DownloadTaskListener = void Function(DownloadTask task)
- float = double
- Type to mark a double property or List to have 32-bit precision.
- Id = int
- Type to specify the id property of a collection.
-
IndexKey
= List<
Object?> - Normal keys consist of a single object, composite keys multiple.
- IsarCloseCallback = void Function(String isarName)
- Callback for a release Isar instance.
- IsarOpenCallback = void Function(Isar isar)
- Callback for a newly opened Isar instance.
- short = int
- Type to mark an int property or List as 32-bit sized.
Exceptions / Errors
- IsarError
- An error raised by Isar.
- IsarUniqueViolationError
- This error is returned when a unique index constraint is violated.