Struct StaticCString 

pub struct StaticCString<const N: usize> { /* private fields */ }

A C-compatible, growable but fixed-capacity string.
The exact encoding of the string depends on the target platform.
The StaticCString guarantees a null-terminator at the end, so the maximum length is 1 less than capacity.

Examples

Implementations

impl<const N: usize> StaticCString<N>

pub const fn new() -> Self

Creates a new empty StaticCString.

Given that the string is empty, the buffer that contains the string isn’t initialized. This means the initial operation is very inexpensive.

Example

use static_collections::ffi::c_str::StaticCString;
let s:StaticCString<32>=StaticCString::from(c"Hello, World!");
assert_eq!(s.len(),13);

pub fn len(&self) -> usize

Returns the length of the static-string by using strnlen.

Example

use static_collections::ffi::c_str::StaticCString;
let s:StaticCString<32>=StaticCString::from(c"Hello, World!");
assert_eq!(s.len(),13);

pub fn is_empty(&self) -> bool

pub const fn capacity(&self) -> usize

Returns the capacity of the static-string.

Example

use static_collections::ffi::c_str::StaticCString;
let s:StaticCString<32>=StaticCString::from(c"Hello, World!");
assert_eq!(s.capacity(),32);

pub const fn as_ptr(&self) -> *const i8

Returns the immutable pointer to the first character.

The returned pointer can be passed to C-FFI routines that accepts raw pointers.

pub const fn as_mut_ptr(&mut self) -> *mut i8

Returns the mutable pointer to the first character.

The returned pointer can be passed to C-FFI routines that accepts raw pointers.

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

Returns the contents of this StaticCString as a slice of bytes.

The returned slice does not contain the trailing null-terminator, and it is guaranteed to not contain any interior null bytes. If you need this null-terminator, use StaticCString::as_bytes_with_nul instead.

pub fn as_mut_bytes(&mut self) -> &mut [u8]

Returns the contents of this StaticCString as a mutable slice of bytes.

The returned slice does not contain the trailing null-terminator, and it is guaranteed to not contain any interior null bytes. If you need this null-terminator, use StaticCString::as_mut_bytes_with_nul instead.

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

Returns the contents of this StaticCString as a slice of bytes, including the trailing null-terminator.

pub unsafe fn as_mut_bytes_with_nul(&mut self) -> &mut [u8]

Returns the contents of this StaticCString as a slice of bytes, including the trailing null-terminator.

Safety

You must ensure the slice contains a null-terminator throughout the lifetime of the slice.

pub fn as_c_str(&self) -> &CStr

impl<'a, const N: usize> StaticCString<N>

pub fn from_raw_ptr(ptr: *const i8) -> Result<&'a Self, NotNullTerminatedError>

pub fn from_raw_mut_ptr( ptr: *mut i8, ) -> Result<&'a mut Self, NotNullTerminatedError>

Trait Implementations

impl<const M: usize, const N: usize> AddAssign<StaticCString<M>> for StaticCString<N>

fn add_assign(&mut self, rhs: StaticCString<M>)

Performs the += operation.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> From<&CStr> for StaticCString<N>

fn from(value: &CStr) -> Self

Converts to this type from the input type.

impl<const M: usize, const N: usize> PartialEq<StaticCString<M>> for StaticCString<N>

fn eq(&self, other: &StaticCString<M>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const M: usize, const N: usize> PartialOrd<StaticCString<M>> for StaticCString<N>

fn partial_cmp(&self, other: &StaticCString<M>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> Send for StaticCString<N>

impl<const N: usize> Sync for StaticCString<N>