eve::artifact::ProviderContract类 参考

Base contract for a consumer-owned artifact provider. 更多...

#include <ArtifactPublication.h>

类 eve::artifact::ProviderContract 继承关系图:

Public 成员函数
virtual	~ProviderContract ()=default
	Provider contract.
virtual eve::Result< std::unique_ptr< PreparedPublication > >	prepare (const PublicationView &publication)=0
	Prepare a provider-local mutation from a borrowed publication view.
virtual eve::Result< eve::Value >	snapshotState () const
	Export backend-neutral observable provider state.
virtual eve::Result< void >	restoreState (const eve::Value &state)
	Transactionally restore backend-neutral observable provider state.
virtual bool	emptyState () const noexcept
	Return whether this provider has no committed observable state.
virtual void	clearState () noexcept
	Clear provider state during aggregate-restore failure cleanup.

详细描述

Base contract for a consumer-owned artifact provider.

在文件 ArtifactPublication.h 第 113 行定义.

构造及析构函数说明

~ProviderContract()

virtual eve::artifact::ProviderContract::~ProviderContract ( )

virtualdefault

Provider contract.

成员函数说明

clearState()

virtual void eve::artifact::ProviderContract::clearState ( )

inlinevirtualnoexcept

Clear provider state during aggregate-restore failure cleanup.

被 eve::graphics::GraphicsArtifactProvider, eve::map::MapArtifactProvider, eve::physics::PhysicsArtifactProvider , 以及 eve::scene::SceneArtifactProvider 重载.

在文件 ArtifactPublication.h 第 143 行定义.

emptyState()

virtual bool eve::artifact::ProviderContract::emptyState ( ) const

inlinevirtualnoexcept

Return whether this provider has no committed observable state.

被 eve::graphics::GraphicsArtifactProvider, eve::map::MapArtifactProvider, eve::physics::PhysicsArtifactProvider , 以及 eve::scene::SceneArtifactProvider 重载.

在文件 ArtifactPublication.h 第 140 行定义.

被这些函数引用 eve::procgen::ArtifactPublisher::restore().

prepare()

virtual eve::Result< std::unique_ptr< PreparedPublication > > eve::artifact::ProviderContract::prepare ( const PublicationView &  publication )

pure virtual

Prepare a provider-local mutation from a borrowed publication view.

参数

publication

Immutable input valid for this call only.

返回

A prepared stage or a structured validation/provider error.

在 eve::graphics::GraphicsArtifactProvider, eve::map::MapArtifactProvider, eve::physics::PhysicsArtifactProvider , 以及 eve::scene::SceneArtifactProvider 内被实现.

restoreState()

eve::Result< void > eve::artifact::ProviderContract::restoreState ( const eve::Value &  state )

virtual

Transactionally restore backend-neutral observable provider state.

参数

state

State previously produced by snapshotState().

返回

Applied or a structured parse/conflict/provider error.

被 eve::graphics::GraphicsArtifactProvider, eve::map::MapArtifactProvider, eve::physics::PhysicsArtifactProvider , 以及 eve::scene::SceneArtifactProvider 重载.

在文件 ArtifactPublication.cpp 第 11 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure() , 以及 eve::Unsupported.

snapshotState()

eve::Result< eve::Value > eve::artifact::ProviderContract::snapshotState ( ) const

virtual

Export backend-neutral observable provider state.

返回

Owning state value suitable for a SnapshotEnvelope payload.

被 eve::graphics::GraphicsArtifactProvider, eve::map::MapArtifactProvider, eve::physics::PhysicsArtifactProvider , 以及 eve::scene::SceneArtifactProvider 重载.

在文件 ArtifactPublication.cpp 第 5 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure() , 以及 eve::Unsupported.

---

该类的文档由以下文件生成:

• src/engine/common/ArtifactPublication.h
• src/engine/common/ArtifactPublication.cpp