Struct BSFixedStringInternal

pub struct BSFixedStringInternal<T>
where
    T: StringFormat,
{ /* private fields */ }

A fixed-length internal string representation used for interacting with the BSStringPool.

This is similar to ::core::ffi::CStr, but supports both char and wchar_t formats through the StringFormat trait.

Type Parameters

• T: The string format (U8 for char or U16 for wchar_t).

Safety

Since this is an FFI type, the encoding is not guaranteed. It may be UTF-8, ANSI, UTF-16LE, or platform-specific wide encoding.

Implementations

impl BSFixedStringInternal<U8>

pub const DEFAULT: Self

const default

pub fn new(data: &CStr) -> Self

Creates a new BSFixedString from a &CStr.

Memory allocation

• If the same string exists inside the allocator, no new memory allocation occurs.

pub unsafe fn new_unchecked(data: *const c_char) -> Self

Creates a new BSFixedString from a raw pointer.

Safety

• data must be a valid null-terminated char string.

Memory allocation

• If the same string exists inside the allocator, no new memory allocation occurs.

pub fn as_c_str(&self) -> &CStr

Gets the string as a CStr.

Encoding

The returned string may not be UTF-8 due to its FFI nature. It is safe to use this as a raw CStr, but converting to str should be done carefully.

pub fn to_str(&self) -> Option<&str>

Converts the string to &str if it is valid UTF-8.

pub fn contains(&self, rhs: &CStr) -> bool

Returns true if CStr passed as argument is contained in this string or not.

impl BSFixedStringInternal<U16>

pub const EMPTY: &'static [u16]

A constant pointer to an empty string.

pub const unsafe fn new_unchecked(data: *const u16) -> Self

Safety

data must be a pointer to a null-terminated UTF-16LE string.

pub fn as_wide(&self) -> &[u16]

Convert as [u16]

pub fn to_string_lossy(&self) -> String

Decode a UTF-16–encoded slice v into a String

pub fn to_string(&self) -> Result<String, FromUtf16Error>

Decode a UTF-16–encoded vector v into a String.

Errors

Invalid UTF-16 encoding

impl<T> BSFixedStringInternal<T>

where T: StringFormat,

pub fn try_acquire(&self)

Tries to acquire a reference to the string in the string pool.

If the string is already in the pool, its reference count is incremented.

pub fn try_release(&mut self)

Tries to release the string from the string pool.

If the string is not null, it decrements its reference count. If the reference count reaches zero, the string is removed from the pool.

pub const unsafe fn get_proxy(&self) -> Option<&mut Entry<T>>

Gets a mutable reference to the BSStringPool::Entry.

Returns None if the string data is null.

Safety

This dereferences a pointer that may point to invalid memory.

pub fn count_bytes_with_null(&self) -> u32

Returns the length of the string.

Returns 0 if the string data is null or the proxy is invalid.

pub fn is_empty(&self) -> bool

Checks whether the string is empty.

Returns true if the string length is zero.

pub fn as_bytes_with_null(&self) -> &[u8]

Converts this C string as a byte slice with null.

Trait Implementations

impl<T: StringFormat> Clone for BSFixedStringInternal<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: StringFormat> Drop for BSFixedStringInternal<T>

fn drop(&mut self)

Executes the destructor for this type.