FastMM documentation
FastMM C++ API 0.6.0
Public headers, tier 1 and tier 2
Loading...
Searching...
No Matches
fastmm::venues::VenueEntry Struct Reference

#include <fastmm/venues/registry.hpp>

Public Types

using Factory = std::unique_ptr< Venue >(*)(VenueId, const VenueSection &, const VenueFactoryOptions &)
 Throws std::invalid_argument (a bad URL, a key the connector rejects); the message names the venue.
 

Public Attributes

std::string_view name
 Every member has a default, so a registration names only the ones it needs.
 
std::string_view summary
 one line for the connector table
 
std::span< const std::string_view > aliases = {}
 other kind values that select this entry
 
std::span< const VenueKeySpec > keys = {}
 the keys it owns, beyond the generic ones
 
VenueCapabilities caps = {}
 
Factory make = nullptr
 

Member Typedef Documentation

◆ Factory

using fastmm::venues::VenueEntry::Factory = std::unique_ptr<Venue> (*)(VenueId, const VenueSection&, const VenueFactoryOptions&)

Throws std::invalid_argument (a bad URL, a key the connector rejects); the message names the venue.

The section's keys have been validated against keys before this is called.

Member Data Documentation

◆ name

std::string_view fastmm::venues::VenueEntry::name

Every member has a default, so a registration names only the ones it needs.

the kind value; outlives the registry

◆ summary

std::string_view fastmm::venues::VenueEntry::summary

one line for the connector table

◆ aliases

std::span<const std::string_view> fastmm::venues::VenueEntry::aliases = {}

other kind values that select this entry

◆ keys

std::span<const VenueKeySpec> fastmm::venues::VenueEntry::keys = {}

the keys it owns, beyond the generic ones

◆ caps

VenueCapabilities fastmm::venues::VenueEntry::caps = {}

◆ make

Factory fastmm::venues::VenueEntry::make = nullptr