Struct vulkanalia_sys::StringArray

#[repr(transparent)]
pub struct StringArray<const N: usize>(_);

An array containing a null-terminated string.

Equality / Hashing

For the purposes of comparing and hashing array strings, any characters after the first null terminator are ignored. The below example demonstrates this property with two strings that differ in the characters that come after the first null terminators.

let string1 = StringArray::<3>::new([0x61, 0, 0]);
let string2 = StringArray::<3>::new([0x61, 0, 0x61]);

assert_eq!(string1, string2);

let mut hasher1 = DefaultHasher::new();
string1.hash(&mut hasher1);
let mut hasher2 = DefaultHasher::new();
string2.hash(&mut hasher2);

assert_eq!(hasher1.finish(), hasher2.finish());

Implementations

impl<const N: usize> StringArray<N>

pub fn new(array: [c_char; N]) -> Self

Constructs a string array from a character array.

Panics

• characters does not contain a null-terminator

pub const fn from_bytes(bytes: &[u8]) -> Self

Constructs a string array from a byte string.

If the byte string is longer than N - 1, then the byte string will be truncated to fit inside of the constructed string array (the last character is reserved for a null terminator). The constructed string array will always be null-terminated regardless if the byte string is or is not null-terminated.

pub fn from_cstr(cstr: &CStr) -> Self

Constructs a string array from a borrowed C string.

If the borrowed C string is longer than N - 1, then the borrowed C string will be truncated to fit inside of the constructed string array (the last character is reserved for a null terminator).

pub unsafe fn from_ptr(ptr: *const c_char) -> Self

Constructs a string array from a pointer to a null-terminated string.

If the null-terminated string is longer than N - 1, then the null-terminated string will be truncated to fit inside of the constructed string array (the last character is reserved for a null terminator).

Safety

• ptr must be a pointer to a null-terminated string

pub fn as_array(&self) -> &[c_char; N]

Gets the underlying character array for this string array.

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

Gets this string array as a slice of bytes.

pub fn as_cstr(&self) -> &CStr

Gets this string array as a borrowed C string.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts this string array to a UTF-8 string (lossily).

Trait Implementations

impl<const N: usize> Clone for StringArray<N>

fn clone(&self) -> StringArray<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for StringArray<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const N: usize> Default for StringArray<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Deref for StringArray<N>

type Target = [c_char; N]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const N: usize> Display for StringArray<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const N: usize> From<[i8; N]> for StringArray<N>

fn from(array: [c_char; N]) -> Self

Performs the conversion.

impl<const N: usize> From<StringArray<N>> for [c_char; N]

fn from(array: StringArray<N>) -> Self

Performs the conversion.

impl<const N: usize> Hash for StringArray<N>

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<const N: usize> PartialEq<StringArray<N>> for StringArray<N>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> Copy for StringArray<N>

impl<const N: usize> Eq for StringArray<N>