Arp::System::Commons::Services::Io::IFileSystemInfoService Class Reference

A generic service to retrieve file system infos. More...

#include <IFileSystemInfoService.hpp>

Inheritance diagram for Arp::System::Commons::Services::Io::IFileSystemInfoService:

Public Types
using	Ptr = std::shared_ptr< IFileSystemInfoService >
using	GetRootDirectoriesResultDelegate = delegate< void(IRscReadEnumerator< RscString< 512 > > &)>
Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	IFileSystemInfoService (void)=default
	Constructs an IFileSystemInfoService instance.
virtual Traits	GetSupportedTraits ()=0
	Gets the supported traits. More...
virtual FileSystemError	GetPermissions (const RscString< 512 > &path, Permissions &permissions)=0
	Gets the permissions of the specified path. More...
virtual FileSystemError	AddPermissions (const RscString< 512 > &path, Permissions permissions)=0
	Adds the permissions to the specified path. More...
virtual FileSystemError	RemovePermissions (const RscString< 512 > &path, Permissions permissions)=0
	Removes the permissions of the specified path. More...
virtual FileSystemError	GetFileSystemTraitsEntry (Traits traits, const RscString< 512 > &path, FileSystemTraitsEntry &fileSystemTraitsEntry)=0
	Gets the file system traits entry of the specified path. More...
virtual FileSystemError	GetSpaceInfo (const RscString< 512 > &path, SpaceInfo &spaceInfo)=0
	Gets the space information of the specified path. More...
virtual void	GetRootDirectories (GetRootDirectoriesResultDelegate resultDelegate)=0
	Deprecated since 2023.6! This method is not supported anymore! Gets a list of all root directories supported by the target. More...
Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.
	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...
	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...
IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...
IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...
virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

A generic service to retrieve file system infos.

The path separator is always '/'.

This service is defined in library Arp.System.Commons.Services.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Consider the following common rule when using RSC services that provide arrays or enumerators as return values or out arguments: It is always required to completely read all items from these resulting lists or enumerators.

Member Function Documentation

AddPermissions()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::AddPermissions ( const RscString< 512 > &  path, Permissions  permissions  )

pure virtual

Adds the permissions to the specified path.

Parameters

path	The path to add the permissions from.
permissions	The permissions to add.

Returns

Result of the action.

GetFileSystemTraitsEntry()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::GetFileSystemTraitsEntry ( Traits  traits, const RscString< 512 > &  path, FileSystemTraitsEntry &  fileSystemTraitsEntry  )

pure virtual

Gets the file system traits entry of the specified path.

Parameters

traits	The selection of traits to get.
path	The path to get the file system traits entry from.
fileSystemTraitsEntry	The file system traits entry of the specified path

Returns

Result of the action.

GetPermissions()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::GetPermissions ( const RscString< 512 > &  path, Permissions &  permissions  )

pure virtual

Gets the permissions of the specified path.

Parameters

path	The path to get the permissions from.
permissions	The permissions of the specified path.

Returns

Result of the action.

GetRootDirectories()

virtual void Arp::System::Commons::Services::Io::IFileSystemInfoService::GetRootDirectories ( GetRootDirectoriesResultDelegate  resultDelegate )

pure virtual

Deprecated since 2023.6! This method is not supported anymore! Gets a list of all root directories supported by the target.

Returns

A list of list of all root directories.

GetSpaceInfo()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::GetSpaceInfo ( const RscString< 512 > &  path, SpaceInfo &  spaceInfo  )

pure virtual

Gets the space information of the specified path.

Parameters

path	The path to get the space information from.
spaceInfo	The space information of the specified path.

Returns

Result of the action.

GetSupportedTraits()

virtual Traits Arp::System::Commons::Services::Io::IFileSystemInfoService::GetSupportedTraits ( )

pure virtual

Gets the supported traits.

Returns

The supported traits as bitset.

RemovePermissions()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::RemovePermissions ( const RscString< 512 > &  path, Permissions  permissions  )

pure virtual

Removes the permissions of the specified path.

Parameters

path	The path to remove the permissions from.
permissions	The permissions to remove.

Returns

Result of the action.

---

The documentation for this class was generated from the following file:

• Arp/System/Commons/Services/Io/IFileSystemInfoService.hpp