PatchResourceGroup

The PatchResourceGroup contains resources specifically of patch type.

See Resource Group File Format file specification for more details.

class PatchResourceGroup : public CarbonResources::ResourceGroup

Contains a collection of Patch Resources.

Public Functions

Result Apply(const PatchApplyParams &params)

Applies the Patches from the BundleResourceGroup.

See also

ResourceGroup::CreatePatch for information regarding patch creation.

Parameters:

params – input parameters, See PatchApplyParams for more details.

Returns:

Result see CarbonResources::Result for more details.

class PatchResourceGroupImpl : public CarbonResources::ResourceGroup::ResourceGroupImpl

Input Parameters

struct PatchApplyParams

Function Parameters required for CarbonResources::PatchResourceGroup::Apply.

Public Members

ResourceSourceSettings patchBinarySourceSettings = {}

Location where patch binaries can be sourced.

ResourceSourceSettings resourcesToPatchSourceSettings = {ResourceSourceType::LOCAL_RELATIVE}

Location where the resources to be patched can be sourced.

ResourceDestinationSettings resourcesToPatchDestinationSettings = {ResourceDestinationType::LOCAL_RELATIVE}

Location where to place patched resources. This can match PatchApplyParams::resourcesToPatchSourceSettings to overwrite. Allows creation of staging area in case of failure.

std::filesystem::path temporaryFilePath = "tempFile.resource"

Name of a temporary filename to use when patching large files. This file will be cleaned up on process completion.

StatusCallback statusCallback = nullptr

Optional status function callback. Callback is triggered at key status update events.