iox2::bb::FilePath Class Reference

Represents a path to a file. It is not allowed to end with a path separator since this would then be a path to a directory. A valid file path is for instance "path/to/file" but not "path/to/file/". More...

#include <file_path.hpp>

Inheritance diagram for iox2::bb::FilePath:

Additional Inherited Members
Public Member Functions inherited from iox2::bb::SemanticString< FilePath, platform::IOX2_MAX_PATH_LENGTH, detail::file_path_does_contain_invalid_content, detail::file_path_does_contain_invalid_characters >
constexpr auto	size () const noexcept -> uint64_t
	Returns the number of characters.
constexpr auto	as_string () const noexcept -> const bb::StaticString< Capacity > &
	Returns a const reference to the underlying string. It is const and shall not be modified to guarantee the contract that a SemanticString contains always a valid value.
auto	append (const T &value) noexcept -> bb::Expected< void, SemanticStringError >
	Appends another string to the SemanticString. If the value contains invalid characters or the result would end up in invalid content it fails.
auto	insert (uint64_t pos, const T &str, uint64_t count) noexcept -> bb::Expected< void, SemanticStringError >
	Inserts another string into the SemanticString. If the value contains invalid characters or the result would end up in invalid content it fails.
auto	operator== (const SemanticString &rhs) const noexcept -> bool
	checks if another SemanticString is equal to this string
auto	operator== (const T &rhs) const noexcept -> bb::RequireStaticStringOrCharArray< T, bool >
	checks if another string or char array is equal to this string
auto	operator!= (const SemanticString &rhs) const noexcept -> bool
	checks if another SemanticString is not equal to this string
auto	operator!= (const T &rhs) const noexcept -> bb::RequireStaticStringOrCharArray< T, bool >
	checks if another string or char array is not equal to this string
auto	operator<= (const SemanticString &rhs) const noexcept -> bool
	checks if another SemanticString is less than or equal this string
auto	operator<= (const T &rhs) const noexcept -> bb::RequireStaticStringOrCharArray< T, bool >
	checks if another string or char array is less than or equal this string
auto	operator< (const SemanticString &rhs) const noexcept -> bool
	checks if another SemanticString is less than this string
auto	operator< (const T &rhs) const noexcept -> bb::RequireStaticStringOrCharArray< T, bool >
	checks if another string or char array is less than this string
auto	operator>= (const SemanticString &rhs) const noexcept -> bool
	checks if another SemanticString is greater than or equal this string
auto	operator>= (const T &rhs) const noexcept -> bb::RequireStaticStringOrCharArray< T, bool >
	checks if another string or char array is greater than or equal this string
auto	operator> (const SemanticString &rhs) const noexcept -> bool
	checks if another SemanticString is greater than this string
auto	operator> (const T &rhs) const noexcept -> bb::RequireStaticStringOrCharArray< T, bool >
	checks if another string or char array is greater than this string
Static Public Member Functions inherited from iox2::bb::SemanticString< FilePath, platform::IOX2_MAX_PATH_LENGTH, detail::file_path_does_contain_invalid_content, detail::file_path_does_contain_invalid_characters >
static auto	create (const char(&value)[N]) noexcept -> bb::Expected< FilePath, SemanticStringError >
	Creates a new SemanticString from the provided string literal. If the value contains invalid characters or invalid content the expected returns an error describing the cause.
static auto	create (const bb::StaticString< N > &value) noexcept -> bb::Expected< FilePath, SemanticStringError >
	Creates a new SemanticString from the provided string. If the value contains invalid characters or invalid content the expected returns an error describing the cause.
static constexpr auto	capacity () noexcept -> uint64_t
	Returns the capacity of the string.
Protected Member Functions inherited from iox2::bb::SemanticString< FilePath, platform::IOX2_MAX_PATH_LENGTH, detail::file_path_does_contain_invalid_content, detail::file_path_does_contain_invalid_characters >
	SemanticString (const bb::StaticString< N > &value) noexcept

Detailed Description

Represents a path to a file. It is not allowed to end with a path separator since this would then be a path to a directory. A valid file path is for instance "path/to/file" but not "path/to/file/".

Definition at line 41 of file file_path.hpp.

---

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

• iox2/bb/file_path.hpp