Blender V5.3
blender::blender::StringRefNull Class Reference

#include <bmesh_polygon.hh>

Inherits blender::blender::StringRefBase.

Inherited by blender::gpu::shader::ResourceString.

Public Member Functions

 StringRefNull (std::nullptr_t)=delete
#StringRefNull Inline Methods
constexpr StringRefNull ()
constexpr StringRefNull (const char *str, int64_t size) ATTR_NONNULL(2)
constexpr StringRefNull (const char *str) ATTR_NONNULL(2)
 StringRefNull (const std::string &str)
constexpr char operator[] (int64_t index) const
constexpr const char * c_str () const
Public Member Functions inherited from blender::blender::StringRefBase
void copy_utf8_truncated (char *dst, int64_t dst_size) const
void copy_bytes_truncated (char *dst, int64_t dst_size) const
constexpr int64_t size () const
constexpr bool is_empty () const
constexpr const char * data () const
constexpr operator Span< char > () const
 operator std::string () const
constexpr operator std::string_view () const
constexpr const char * begin () const
constexpr const char * end () const
constexpr IndexRange index_range () const
template<size_t N>
void copy_utf8_truncated (char(&dst)[N]) const
template<size_t N>
void copy_bytes_truncated (char(&dst)[N]) const
void copy_unsafe (char *dst) const
constexpr bool startswith (StringRef prefix) const
constexpr bool endswith (StringRef suffix) const
constexpr StringRef substr (int64_t start, int64_t size) const
constexpr const char & front () const
constexpr const char & back () const
constexpr int64_t find (char c, int64_t pos=0) const
constexpr int64_t find (StringRef str, int64_t pos=0) const
constexpr int64_t rfind (char c, int64_t pos=INT64_MAX) const
constexpr int64_t rfind (StringRef str, int64_t pos=INT64_MAX) const
constexpr int64_t find_first_of (StringRef chars, int64_t pos=0) const
constexpr int64_t find_first_of (char c, int64_t pos=0) const
constexpr int64_t find_last_of (StringRef chars, int64_t pos=INT64_MAX) const
constexpr int64_t find_last_of (char c, int64_t pos=INT64_MAX) const
constexpr int64_t find_first_not_of (StringRef chars, int64_t pos=0) const
constexpr int64_t find_first_not_of (char c, int64_t pos=0) const
constexpr int64_t find_last_not_of (StringRef chars, int64_t pos=INT64_MAX) const
constexpr int64_t find_last_not_of (char c, int64_t pos=INT64_MAX) const
constexpr StringRef trim () const
constexpr StringRef trim (StringRef characters_to_remove) const
constexpr StringRef trim (char character_to_remove) const
constexpr StringRef trim_left () const
constexpr StringRef trim_left (StringRef characters_to_remove) const
constexpr StringRef trim_right () const
constexpr StringRef trim_right (StringRef characters_to_remove) const

Additional Inherited Members

Public Types inherited from blender::blender::StringRefBase
using value_type = char
Static Public Attributes inherited from blender::blender::StringRefBase
static constexpr int64_t not_found = -1
constexpr StringRefBase (const char *data, int64_t size)
Protected Attributes inherited from blender::blender::StringRefBase
const char * data_
int64_t size_

Detailed Description

References a null-terminated const char array.

StringRefNull can be compared with StringRef and StringRefNull.

Definition at line 144 of file bmesh_polygon.hh.

Constructor & Destructor Documentation

◆ StringRefNull() [1/5]

◆ StringRefNull() [2/5]

blender::blender::StringRefNull::StringRefNull ( const char * str,
int64_t size )
constexpr

Construct a StringRefNull from a null terminated c-string. This invokes undefined behavior when the given size is not the correct size of the string.

Definition at line 502 of file BLI_string_ref.hh.

References blender::BLI_assert(), blender::blender::StringRefBase::size(), str, and blender::blender::StringRefBase::StringRefBase().

◆ StringRefNull() [3/5]

blender::blender::StringRefNull::StringRefNull ( std::nullptr_t )
delete

◆ StringRefNull() [4/5]

blender::blender::StringRefNull::StringRefNull ( const char * str)
constexpr

Construct a StringRefNull from a null terminated c-string. The pointer must not point to NULL.

Definition at line 512 of file BLI_string_ref.hh.

References blender::BLI_assert(), blender::blender::StringRefBase::data_, length(), blender::blender::StringRefBase::size_, str, and blender::blender::StringRefBase::StringRefBase().

◆ StringRefNull() [5/5]

blender::blender::StringRefNull::StringRefNull ( const std::string & str)
inline

Reference a std::string. Remember that when the std::string is destructed, the StringRefNull will point to uninitialized memory.

Definition at line 523 of file BLI_string_ref.hh.

References c_str(), blender::blender::StringRefBase::size(), str, and StringRefNull().

Member Function Documentation

◆ c_str()

const char * blender::blender::StringRefNull::c_str ( ) const
constexpr

Returns the beginning of a null-terminated char array.

This is like ->data(), but can only be called on a StringRefNull.

Definition at line 544 of file BLI_string_ref.hh.

References blender::blender::StringRefBase::data_.

Referenced by blender::acf_action_slot_name(), blender::colormanage_check_display_settings(), blender::colormanage_check_view_settings(), blender::colormanage_imbuf_make_linear(), blender::colormanage_load_config(), blender::colormanage_role_color_space_name_get(), blender::compare_asset_catalog(), blender::foreach_libblock_remap_callback(), blender::gpu_material_library_use_function(), blender::pose_bone_blend_to(), blender::print_default_info(), blender::rna_auto_types(), blender::rna_def_function_funcs(), blender::rna_def_node_item_array_common_functions(), blender::rna_def_node_item_array_new_with_socket_and_name(), blender::rna_def_node_item_array_socket_item_common(), blender::rna_def_property_begin_func(), blender::rna_def_property_boolean_sdna(), blender::RNA_def_property_collection_sdna(), blender::RNA_def_property_enum_sdna(), blender::RNA_def_property_float_sdna(), blender::rna_def_property_get_func(), blender::RNA_def_property_int_sdna(), blender::rna_def_property_length_func(), blender::rna_def_property_sdna(), blender::rna_def_property_set_func(), blender::rna_find_dna_type(), blender::rna_generate_static_parameter_prototypes(), blender::rna_print_data_get(), blender::rna_set_raw_offset(), blender::gpu::shader::ResourceString::str_no_array(), and StringRefNull().

◆ operator[]()

char blender::blender::StringRefNull::operator[] ( int64_t index) const
constexpr

Get the char at the given index.

Definition at line 531 of file BLI_string_ref.hh.

References blender::BLI_assert(), blender::blender::StringRefBase::data_, and blender::blender::StringRefBase::size_.


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