Source parameters for filesystem source. More...

#include <filesystem.h>

Inheritance diagram for Filesystem::Parameters:

Collaboration diagram for Filesystem::Parameters:

[legend]

Public Member Functions
	Parameters (Ownership::Type perm, User *user=nullptr)

	Parameters (const UserData::JSONData &src)
	Create new connection parameters, retrieving values from user settings. More...

virtual bool	persist (UserData::JSONData &dest) const override final
	Copy connection parameters into a user settings dictionary. More...

void	sanitize (void)
	Sanity check the parameters and make adjustments if required. More...

Public Member Functions inherited from MusicLibrary::LibraryParameters
	LibraryParameters (Ownership::Type perm, User *user)

	LibraryParameters (const UserData::JSONData &src)

void	extractOptions (const Parsnip::Data &options)

Public Member Functions inherited from Media::SourceParameters
	SourceParameters (void)

	SourceParameters (Ownership::Type perm, User *user=nullptr)

	SourceParameters (Ownership::Type perm, const std::string &sourcename)

	SourceParameters (const UserData::JSONData &src)

virtual	~SourceParameters ()

void	extractOptions (const Parsnip::Data &options)

Public Attributes
std::string	path

Public Attributes inherited from MusicLibrary::LibraryParameters
int	recent_bias = BIAS_NEUTRAL
	Amount of bias to apply for time since last play. More...

int	rating_bias = BIAS_NEUTRAL
	Amount of bias to apply for user ratings. More...

ScanFrequency	scan_frequency = ScanFrequency::NEXTSTARTUP

Public Attributes inherited from Media::SourceParameters
ProxyMode	song_proxy = ProxyMode::None

User *	owner = nullptr

Ownership::Type	permissions = Ownership::Type::PRIVATE

PersistenceMode	persistence = PersistenceMode::Temporary
	Persistence state. More...

std::string	name

bool	waitForReady = false
	Wait on initialization. Flag never persisted. More...

Additional Inherited Members
Static Public Member Functions inherited from MusicLibrary::LibraryParameters
static Parsnip::OptionParser::Definitions	parser_definitions ()

Static Public Member Functions inherited from Media::SourceParameters
static const Parsnip::OptionParser::Definitions &	parser_definitions ()

Detailed Description

Source parameters for filesystem source.

Constructor & Destructor Documentation

Filesystem::Parameters::Parameters	(	Ownership::Type	perm,
		User *	user = `nullptr`
	)

Filesystem::Parameters::Parameters ( const UserData::JSONData & src )

Create new connection parameters, retrieving values from user settings.

Parameters

src	A user settings dictionary to retrieve settings from.

Exceptions

invalid_argument if values in the settings dictionary are invalid.

Here is the call graph for this function:

bool Filesystem::Parameters::persist ( UserData::JSONData & dest ) const

finaloverridevirtual

Copy connection parameters into a user settings dictionary.

Here is the call graph for this function:

void Filesystem::Parameters::sanitize ( void )

Sanity check the parameters and make adjustments if required.

Here is the caller graph for this function:

std::string Filesystem::Parameters::path

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