Asset

#include <icy/pacm/package.h>

struct Asset

Defined in src/pacm/include/icy/pacm/package.h:60

Public Attributes

Return	Name	Description
`json::Value` &	`root`

root

json::Value & root

Type: json::Value &

Defined in src/pacm/include/icy/pacm/package.h:101

Public Methods

Return	Name	Description
	`Asset`
	`Asset`	Defaulted constructor.
	`~Asset` virtual noexcept
`std::string`	`fileName` virtual const	Returns the archive file name (e.g. "my-plugin-1.0.0.zip").
`std::string`	`version` virtual const	Returns the package version string (e.g. "1.0.0").
`std::string`	`sdkVersion` virtual const	Returns the SDK version this asset was built against (e.g. "2.0.0").
`std::string`	`checksum` virtual const	Returns the asset checksum string, or empty if none is set.
`std::string`	`url` virtual const	Returns the download URL from the mirror list at `index`.
`int`	`fileSize` virtual const	Returns the uncompressed file size in bytes, or 0 if not set.
`bool`	`valid` virtual const	Returns true if the asset has a file name, version, checksum, and at least one HTTPS mirror URL.
`void`	`print` virtual const	Writes the raw JSON of this asset to `ost`.
`Asset` &	`operator=` virtual	Copies the backing JSON node from `r`.
`bool`	`operator==` virtual const	Returns true if file name, version and checksum all match `r`.

Asset

Asset(json::Value & src)

Defined in src/pacm/include/icy/pacm/package.h:63

Parameters

Parameter	Type	Description
`src`	`json::Value` &	JSON object node that backs this asset.

Asset

Asset(const Asset &) = default

Defined in src/pacm/include/icy/pacm/package.h:64

Defaulted constructor.

~Asset

virtual noexcept

virtual ~Asset() noexcept

Defined in src/pacm/include/icy/pacm/package.h:65

fileName

virtual const

virtual std::string fileName() const

Defined in src/pacm/include/icy/pacm/package.h:68

Returns the archive file name (e.g. "my-plugin-1.0.0.zip").

version

virtual const

virtual std::string version() const

Defined in src/pacm/include/icy/pacm/package.h:71

Returns the package version string (e.g. "1.0.0").

sdkVersion

virtual const

virtual std::string sdkVersion() const

Defined in src/pacm/include/icy/pacm/package.h:74

Returns the SDK version this asset was built against (e.g. "2.0.0").

checksum

virtual const

virtual std::string checksum() const

Defined in src/pacm/include/icy/pacm/package.h:77

Returns the asset checksum string, or empty if none is set.

url

virtual const

virtual std::string url(int index = 0) const

Defined in src/pacm/include/icy/pacm/package.h:81

Returns the download URL from the mirror list at index.

Parameters

Parameter	Type	Description
`index`	`int`	Zero-based index into the mirrors array.

fileSize

virtual const

virtual int fileSize() const

Defined in src/pacm/include/icy/pacm/package.h:84

Returns the uncompressed file size in bytes, or 0 if not set.

valid

virtual const

virtual bool valid() const

Defined in src/pacm/include/icy/pacm/package.h:88

Returns true if the asset has a file name, version, checksum, and at least one HTTPS mirror URL.

print

virtual const

virtual void print(std::ostream & ost) const

Defined in src/pacm/include/icy/pacm/package.h:92

Writes the raw JSON of this asset to ost.

Parameters

Parameter	Type	Description
`ost`	`std::ostream &`	Output stream.

operator=

virtual

virtual Asset & operator=(const Asset & r)

Defined in src/pacm/include/icy/pacm/package.h:96

Copies the backing JSON node from r.

Parameters

Parameter	Type	Description
`r`	const `Asset` &	Source asset to copy from.

operator==

virtual const

virtual bool operator==(const Asset & r) const

Defined in src/pacm/include/icy/pacm/package.h:99

Returns true if file name, version and checksum all match r.