echomap::RegisterVFSMappingNotification Struct Reference

A notification to indicate a new VFS mapping from an external source. More...

#include <RegisterVFSMappingNotification.hpp>

Public Member Functions
	RegisterVFSMappingNotification (id_type project_id, std::filesystem::path external, std::filesystem::path internal)
	Creates a new RegisterVFSMappingNotification to express a mapping between the external and internal paths.
void	verify_project (const PartialProject *context) const
	Verify that the given Project matches the intended target.

Public Attributes
id_type	project_id
	The ID of the Project to which the mapping relates.
std::filesystem::path	external
	The path on the external file system.
std::filesystem::path	internal
	The path on the internal file system.

Detailed Description

A notification to indicate a new VFS mapping from an external source.

Produced by the ActionController on RegisterVFSMapping callbacks to indicate a new VFS file mapping has been defined by the user.

Definition at line 32 of file RegisterVFSMappingNotification.hpp.

Constructor & Destructor Documentation

RegisterVFSMappingNotification()

echomap::RegisterVFSMappingNotification::RegisterVFSMappingNotification	(	id_type	project_id,
		std::filesystem::path	external,
		std::filesystem::path	internal )

Creates a new RegisterVFSMappingNotification to express a mapping between the external and internal paths.

Parameters

project_id	The ID of the Project to which the mapping relates.
external	The path on the external (inaccessible) file system as referenced in Project files.
internal	The path on the internal (accessible) VFS corresponding to the external path.

Definition at line 20 of file RegisterVFSMappingNotification.cpp.

  :
    project_id(project_id),
    external(std::move(external)),
    internal(std::move(internal))
{
}

Member Function Documentation

verify_project()

void echomap::RegisterVFSMappingNotification::verify_project

(

const PartialProject *

context

)

const

Verify that the given Project matches the intended target.

Parameters

context

The context to which the notification will apply.

Exceptions

IgnoredWarning

The notification does not apply to the given context and should be ignored.

Definition at line 31 of file RegisterVFSMappingNotification.cpp.

{
    if (context == nullptr)
        throw IgnoredWarning("Dropping RegisterVFSMappingNotification due to empty project.");
 
    if (context->get_id() != project_id)
        throw IgnoredWarning(
                std::format(
                        "Dropping RegisterVFSMappingNotification due to invalid project: requested {}, but have {}.",
                        project_id,
                        context->get_id()
                )
        );
}

Member Data Documentation

external

std::filesystem::path echomap::RegisterVFSMappingNotification::external

The path on the external file system.

Definition at line 56 of file RegisterVFSMappingNotification.hpp.

internal

std::filesystem::path echomap::RegisterVFSMappingNotification::internal

The path on the internal file system.

Definition at line 57 of file RegisterVFSMappingNotification.hpp.

project_id

id_type echomap::RegisterVFSMappingNotification::project_id

The ID of the Project to which the mapping relates.

Definition at line 55 of file RegisterVFSMappingNotification.hpp.

---

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

• src/notifications/web/RegisterVFSMappingNotification.hpp
• src/notifications/web/RegisterVFSMappingNotification.cpp