capabilities.hpp File Reference

#include <cstdint>
#include <optional>
#include <span>
#include <string_view>
#include <pulp/inspect/capability_definitions.inc>

Go to the source code of this file.

Classes
struct	pulp::inspect::InspectorMethodDescriptor
struct	pulp::inspect::InspectorCapabilityDescriptor

Namespaces
namespace	pulp
namespace	pulp::inspect

Macros
#define	PULP_INSPECT_CAPABILITY(symbol, legacy_id, contract_id, risk, side_effect, executor, evidence, observe, develop, grantable, publication_bound)

Enumerations
enum class	pulp::inspect::InspectorCapability : std::uint8_t {   pulp::inspect::SessionDescribe , pulp::inspect::SessionControl , pulp::inspect::StateRead , pulp::inspect::GpuHealthRead ,   pulp::inspect::RenderOffline , pulp::inspect::UiRead , pulp::inspect::DiagnosticsRead , pulp::inspect::LogsRead ,   pulp::inspect::CaptureImage , pulp::inspect::UiInput , pulp::inspect::TraceControl , pulp::inspect::TraceSessionControl ,   pulp::inspect::StateWrite , pulp::inspect::TestInput , pulp::inspect::AuthoringTweaks , pulp::inspect::TelemetryStream ,   pulp::inspect::RuntimeReload , pulp::inspect::RuntimeEval , pulp::inspect::ArtifactRead , pulp::inspect::SequencerStateRead ,   pulp::inspect::SequencerStateEdit , pulp::inspect::SequencerTransportRead , pulp::inspect::SequencerTransportWrite , pulp::inspect::TimelineDocumentSession ,   pulp::inspect::GraphSampleRegionRead , pulp::inspect::GraphSampleRegionEdit , pulp::inspect::ModulationRouteEdit , pulp::inspect::Unavailable }
enum class	pulp::inspect::InspectorMethodKind : std::uint8_t { pulp::inspect::Request , pulp::inspect::Event }
enum class	pulp::inspect::InspectorCapabilityRisk : std::uint8_t {   pulp::inspect::Observe , pulp::inspect::Sensitive , pulp::inspect::StreamingSensitive , pulp::inspect::ResourceConsuming ,   pulp::inspect::Control , pulp::inspect::HighRisk , pulp::inspect::Critical , pulp::inspect::Unavailable }
enum class	pulp::inspect::InspectorProfile : std::uint8_t { pulp::inspect::Off , pulp::inspect::Observe , pulp::inspect::Develop , pulp::inspect::Custom }
enum class	pulp::inspect::InspectorSideEffect : std::uint8_t {   pulp::inspect::None , pulp::inspect::Session , pulp::inspect::State , pulp::inspect::Capture ,   pulp::inspect::Trace , pulp::inspect::TestInput , pulp::inspect::Authoring , pulp::inspect::Telemetry ,   pulp::inspect::Evaluation , pulp::inspect::Render , pulp::inspect::Input , pulp::inspect::Reload ,   pulp::inspect::ArtifactRead }
enum class	pulp::inspect::InspectorExecutor : std::uint8_t {   pulp::inspect::Protocol , pulp::inspect::HostMain , pulp::inspect::Background , pulp::inspect::RuntimeEvaluator ,   pulp::inspect::OfflineJob }
enum class	pulp::inspect::InspectorEvidence : std::uint8_t { pulp::inspect::Response , pulp::inspect::Receipt , pulp::inspect::Artifact , pulp::inspect::Stream }

Functions
std::span< const InspectorCapabilityDescriptor >	pulp::inspect::inspector_capability_registry ()
std::string_view	pulp::inspect::capability_id (InspectorCapability capability)
std::string_view	pulp::inspect::capability_contract_id (InspectorCapability capability)
std::optional< InspectorCapability >	pulp::inspect::capability_from_id (std::string_view id)
std::optional< InspectorCapability >	pulp::inspect::capability_from_contract_id (std::string_view id)
std::string_view	pulp::inspect::capability_risk_id (InspectorCapabilityRisk risk)
std::string_view	pulp::inspect::side_effect_id (InspectorSideEffect side_effect)
std::string_view	pulp::inspect::executor_id (InspectorExecutor executor)
std::string_view	pulp::inspect::evidence_id (InspectorEvidence evidence)
std::string_view	pulp::inspect::profile_id (InspectorProfile profile)
std::optional< InspectorProfile >	pulp::inspect::profile_from_id (std::string_view id)
std::span< const InspectorCapability >	pulp::inspect::profile_capabilities (InspectorProfile profile)
std::span< const InspectorMethodDescriptor >	pulp::inspect::inspector_method_registry ()
const InspectorMethodDescriptor *	pulp::inspect::find_inspector_method (std::string_view method)
bool	pulp::inspect::capability_is_grantable (InspectorCapability capability)
InspectorCapabilityRisk	pulp::inspect::capability_risk (InspectorCapability capability)
bool	pulp::inspect::capability_requires_controller_lease (InspectorCapability capability)
bool	pulp::inspect::capability_requires_publication_binding (InspectorCapability capability)
bool	pulp::inspect::inspector_event_is_lossy (std::string_view method)

Macro Definition Documentation

PULP_INSPECT_CAPABILITY

#define PULP_INSPECT_CAPABILITY	(		symbol,
			legacy_id,
			contract_id,
			risk,
			side_effect,
			executor,
			evidence,
			observe,
			develop,
			grantable,
			publication_bound )

Value:

symbol,