flutter::APKAssetProvider Class Reference

#include <apk_asset_provider.h>

Inheritance diagram for flutter::APKAssetProvider:

Public Member Functions
	APKAssetProvider (JNIEnv *env, jobject assetManager, std::string directory)
	APKAssetProvider (std::shared_ptr< APKAssetProviderInternal > impl)
	~APKAssetProvider ()=default
std::unique_ptr< APKAssetProvider >	Clone () const
APKAssetProviderInternal *	GetImpl () const
bool	operator== (const AssetResolver &other) const override
Public Member Functions inherited from flutter::AssetResolver
	AssetResolver ()=default
virtual	~AssetResolver ()=default
virtual const AssetManager *	as_asset_manager () const
virtual const DirectoryAssetBundle *	as_directory_asset_bundle () const
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.
bool	operator!= (const AssetResolver &other) const

Private Member Functions
bool	IsValid () const override
bool	IsValidAfterAssetManagerChange () const override
	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.
AssetResolver::AssetResolverType	GetType () const override
	Gets the type of AssetResolver this is. Types are defined in AssetResolverType.
std::unique_ptr< fml::Mapping >	GetAsMapping (const std::string &asset_name) const override
const APKAssetProvider *	as_apk_asset_provider () const override

Additional Inherited Members
Public Types inherited from flutter::AssetResolver
enum	AssetResolverType { kAssetManager , kApkAssetProvider , kDirectoryAssetBundle }
	Identifies the type of AssetResolver an instance is. More...

Detailed Description

Definition at line 26 of file apk_asset_provider.h.

Constructor & Destructor Documentation

APKAssetProvider() [1/2]

flutter::APKAssetProvider::APKAssetProvider ( JNIEnv *  env, jobject  assetManager, std::string  directory  )

explicit

Definition at line 71 of file apk_asset_provider.cc.

    : impl_(std::make_shared<APKAssetProviderImpl>(env,
                                                   assetManager,
                                                   std::move(directory))) {}

APKAssetProvider() [2/2]

flutter::APKAssetProvider::APKAssetProvider ( std::shared_ptr< APKAssetProviderInternal >  impl )

explicit

Definition at line 78 of file apk_asset_provider.cc.

    : impl_(std::move(impl)) {}

~APKAssetProvider()

flutter::APKAssetProvider::~APKAssetProvider ( )

default

Member Function Documentation

as_apk_asset_provider()

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

inlineoverrideprivatevirtual

Reimplemented from flutter::AssetResolver.

Definition at line 65 of file apk_asset_provider.h.

                                                                 {
    return this;
  }

Clone()

std::unique_ptr< APKAssetProvider > flutter::APKAssetProvider::Clone

(

)

const

Definition at line 103 of file apk_asset_provider.cc.

                                                              {
  return std::make_unique<APKAssetProvider>(impl_);
}

GetAsMapping()

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

overrideprivatevirtual

Implements flutter::AssetResolver.

Definition at line 98 of file apk_asset_provider.cc.

                                       {
  return impl_->GetAsMapping(asset_name);
}

GetImpl()

APKAssetProviderInternal * flutter::APKAssetProvider::GetImpl ( ) const

inline

Definition at line 44 of file apk_asset_provider.h.

{ return impl_.get(); }

GetType()

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

overrideprivatevirtual

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

Returns

Returns the AssetResolverType that this resolver is.

Implements flutter::AssetResolver.

Definition at line 93 of file apk_asset_provider.cc.

                                                               {
  return AssetResolver::AssetResolverType::kApkAssetProvider;
}

IsValid()

bool flutter::APKAssetProvider::IsValid ( ) const

overrideprivatevirtual

Implements flutter::AssetResolver.

Definition at line 83 of file apk_asset_provider.cc.

                                     {
  return true;
}

IsValidAfterAssetManagerChange()

bool flutter::APKAssetProvider::IsValidAfterAssetManagerChange ( ) const

overrideprivatevirtual

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.

Implements flutter::AssetResolver.

Definition at line 88 of file apk_asset_provider.cc.

                                                            {
  return true;
}

operator==()

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

overridevirtual

Implements flutter::AssetResolver.

Definition at line 107 of file apk_asset_provider.cc.

                                                                  {
  auto other_provider = other.as_apk_asset_provider();
  if (!other_provider) {
    return false;
  }
  return impl_ == other_provider->impl_;
}

---

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

• shell/platform/android/apk_asset_provider.h
• shell/platform/android/apk_asset_provider.cc