flutter::AssetResolver Class Reference

#include <asset_resolver.h>

Inheritance diagram for flutter::AssetResolver:

Public Types
enum	AssetResolverType { kAssetManager , kApkAssetProvider , kDirectoryAssetBundle }
	Identifies the type of AssetResolver an instance is. More...

Public Member Functions
	AssetResolver ()=default
virtual	~AssetResolver ()=default
virtual const AssetManager *	as_asset_manager () const
virtual const APKAssetProvider *	as_apk_asset_provider () const
virtual const DirectoryAssetBundle *	as_directory_asset_bundle () const
virtual bool	IsValid () const =0
virtual bool	IsValidAfterAssetManagerChange () const =0
	Certain asset resolvers are still valid after the asset manager is replaced before a hot reload, or after a new run configuration is created during a hot restart. By preserving these resolvers and re-inserting them into the new resolver or run configuration, the tooling can avoid needing to sync all application assets through the Dart devFS upon connecting to the VM Service. Besides improving the startup performance of running a Flutter application, it also reduces the occurrence of tool failures due to repeated network flakes caused by damaged cables or hereto unknown bugs in the Dart HTTP server implementation.
virtual AssetResolverType	GetType () const =0
	Gets the type of AssetResolver this is. Types are defined in AssetResolverType.
virtual std::unique_ptr< fml::Mapping >	GetAsMapping (const std::string &asset_name) const =0
virtual std::vector< std::unique_ptr< fml::Mapping > >	GetAsMappings (const std::string &asset_pattern, const std::optional< std::string > &subdir) const
	Same as GetAsMapping() but returns mappings for all files who's name matches a given pattern. Returns empty vector if no matching assets are found.
virtual bool	operator== (const AssetResolver &other) const =0
bool	operator!= (const AssetResolver &other) const

Detailed Description

Definition at line 21 of file asset_resolver.h.

Member Enumeration Documentation

AssetResolverType

enum flutter::AssetResolver::AssetResolverType

Identifies the type of AssetResolver an instance is.

Enumerator
kAssetManager
kApkAssetProvider
kDirectoryAssetBundle

Definition at line 30 of file asset_resolver.h.

                         {
    kAssetManager,
    kApkAssetProvider,
    kDirectoryAssetBundle
  };

Constructor & Destructor Documentation

AssetResolver()

flutter::AssetResolver::AssetResolver ( )

default

~AssetResolver()

virtual flutter::AssetResolver::~AssetResolver ( )

virtualdefault

Member Function Documentation

as_apk_asset_provider()

virtual const APKAssetProvider * flutter::AssetResolver::as_apk_asset_provider ( ) const

inlinevirtual

Reimplemented in flutter::APKAssetProvider.

Definition at line 37 of file asset_resolver.h.

                                                                {
    return nullptr;
  }

as_asset_manager()

virtual const AssetManager * flutter::AssetResolver::as_asset_manager ( ) const

inlinevirtual

Reimplemented in flutter::AssetManager.

Definition at line 36 of file asset_resolver.h.

{ return nullptr; }

as_directory_asset_bundle()

virtual const DirectoryAssetBundle * flutter::AssetResolver::as_directory_asset_bundle ( ) const

inlinevirtual

Reimplemented in flutter::DirectoryAssetBundle.

Definition at line 40 of file asset_resolver.h.

                                                                        {
    return nullptr;
  }

GetAsMapping()

virtual std::unique_ptr< fml::Mapping > flutter::AssetResolver::GetAsMapping ( const std::string &  asset_name ) const

pure virtual

Implemented in flutter::AssetManager, flutter::DirectoryAssetBundle, flutter::testing::TestAssetResolver, flutter::testing::ThreadCheckingAssetResolver, and flutter::APKAssetProvider.

GetAsMappings()

virtual std::vector< std::unique_ptr< fml::Mapping > > flutter::AssetResolver::GetAsMappings ( const std::string &  asset_pattern, const std::optional< std::string > &  subdir  ) const

inlinevirtual

Same as GetAsMapping() but returns mappings for all files who's name matches a given pattern. Returns empty vector if no matching assets are found.

Parameters

[in]	asset_pattern	The pattern to match file names against.
[in]	subdir	Optional subdirectory in which to search for files. If supplied this function does a flat search within the subdirectory instead of a recursive search through the entire assets directory.

Returns

Returns a vector of mappings of files which match the search parameters.

Reimplemented in flutter::AssetManager, flutter::DirectoryAssetBundle, and flutter::testing::TestAssetResolver.

Definition at line 91 of file asset_resolver.h.

                                                            {
    return {};
  };

GetType()

virtual AssetResolverType flutter::AssetResolver::GetType ( ) const

pure virtual

Gets the type of AssetResolver this is. Types are defined in AssetResolverType.

Returns

Returns the AssetResolverType that this resolver is.

Implemented in flutter::testing::ThreadCheckingAssetResolver, flutter::AssetManager, flutter::DirectoryAssetBundle, flutter::testing::TestAssetResolver, and flutter::APKAssetProvider.

IsValid()

virtual bool flutter::AssetResolver::IsValid ( ) const

pure virtual

Implemented in flutter::AssetManager, flutter::DirectoryAssetBundle, flutter::testing::TestAssetResolver, flutter::testing::ThreadCheckingAssetResolver, and flutter::APKAssetProvider.

IsValidAfterAssetManagerChange()

virtual bool flutter::AssetResolver::IsValidAfterAssetManagerChange ( ) const

pure virtual

Certain asset resolvers are still valid after the asset manager is replaced before a hot reload, or after a new run configuration is created during a hot restart. By preserving these resolvers and re-inserting them into the new resolver or run configuration, the tooling can avoid needing to sync all application assets through the Dart devFS upon connecting to the VM Service. Besides improving the startup performance of running a Flutter application, it also reduces the occurrence of tool failures due to repeated network flakes caused by damaged cables or hereto unknown bugs in the Dart HTTP server implementation.

Returns

Returns whether this resolver is valid after the asset manager or run configuration is updated.

Implemented in flutter::AssetManager, flutter::DirectoryAssetBundle, flutter::testing::TestAssetResolver, flutter::testing::ThreadCheckingAssetResolver, and flutter::APKAssetProvider.

operator!=()

bool flutter::AssetResolver::operator!= ( const AssetResolver &  other ) const

inline

Definition at line 98 of file asset_resolver.h.

                                                    {
    return !operator==(other);
  }

operator==()

virtual bool flutter::AssetResolver::operator== ( const AssetResolver &  other ) const

pure virtual

Implemented in flutter::AssetManager, flutter::DirectoryAssetBundle, flutter::testing::TestAssetResolver, flutter::testing::ThreadCheckingAssetResolver, and flutter::APKAssetProvider.

---

The documentation for this class was generated from the following file:

• assets/asset_resolver.h