ArWritableAsset Class Reference

#include <writableAsset.h>

Inheritance diagram for ArWritableAsset:

Public Member Functions
virtual AR_API	~ArWritableAsset ()
	ArWritableAsset (const ArWritableAsset &)=delete
ArWritableAsset &	operator= (const ArWritableAsset &)=delete
virtual bool	Close ()=0
virtual size_t	Write (const void *buffer, size_t count, size_t offset)=0

Protected Member Functions
AR_API	ArWritableAsset ()

Detailed Description

Interface for writing data to an asset.

See Also

ArResolver::OpenAssetForWrite for how to retrieve instances of this object.

Definition at line 43 of file writableAsset.h.

Constructor & Destructor Documentation

virtual AR_API ArWritableAsset::~ArWritableAsset ( )

virtual

ArWritableAsset::ArWritableAsset ( const ArWritableAsset &  )

delete

AR_API ArWritableAsset::ArWritableAsset ( )

protected

Member Function Documentation

virtual bool ArWritableAsset::Close ( )

pure virtual

Close this asset, performing any necessary finalization or commits of data that was previously written. Returns true on success, false otherwise.

If successful, reads to the written asset in the same process should reflect the fully written state by the time this function returns. Also, further calls to any functions on this interface are invalid.

Implemented in ArFilesystemWritableAsset.

ArWritableAsset& ArWritableAsset::operator= ( const ArWritableAsset &  )

delete

virtual size_t ArWritableAsset::Write ( const void *  buffer, size_t  count, size_t  offset  )

pure virtual

Writes count bytes from buffer at offset from the beginning of the asset. Returns number of bytes written, or 0 on error.

Implemented in ArFilesystemWritableAsset.

---

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

• pxr/usd/ar/writableAsset.h