Struct CFixedString

pub struct CFixedString { /* private fields */ }

This type owns a fixed length buffer containing a C-style string. The string is terminated by the first null byte in the buffer, or by the length of the buffer if no null byte is present.

The length of the buffer is known as the limit of the CFixedString. The len() method returns the length of the string within the buffer.

Any bytes after the first null byte are not considered part of the string and may contain garbage data. When comparing or hashing CFixedStrings, these bytes are not included.

Performance

Be aware that many of the methods on this type which would normally be expected to run in constant time may run in time linear in the length of the string. For this reason, it is recommended to use the type only for interop with C code, and to convert to a standard string or byte buffer as soon as possible.

Implementations

impl CFixedString

pub fn new<T: Into<Box<[u8]>>>(t: T) -> CFixedString

Construct a new fixed-length C string from a byte slice The first null byte terminates the string, but the length of the slice determines the limit of this fixed-size string.

pub fn with_limit(limit: usize) -> CFixedString

Construct an empty string with the specified limit. The buffer is entirely zero-initialized.

pub unsafe fn from_raw_parts(ptr: *mut c_char, limit: usize) -> CFixedString

Retakes ownership of a CFixedString that was transferred to C.

Safety

This should only ever be called with a pointer and limit that was earlier obtained from a CFixedString. The previous string must have been forgotten to ensure that the memory has not already been freed.

pub fn into_string(self) -> Result<String, IntoStringError>

Converts the CFixedString into a String if it contains valid Unicode data.

On failure, ownership of the original CFixedString is returned.

pub fn into_c_string(self) -> CString

Converts the CFixedString into a CString. If necessary, the buffer will be extended to make room for a final null byte. If the buffer does not need to be extended, no allocation will be performed.

pub fn into_bytes(self) -> Vec<u8>

Converts the CFixedString into a byte buffer. The length of the buffer will equal the length of the string up to but not including the first null byte. The capacity of the buffer will equal the limit of the CFixedString.

pub fn into_bytes_full(self) -> Vec<u8>

Converts the CFixedString into a byte buffer. The length of the buffer will equal the limit of the CFixedString. The buffer may contain garbage values after the first null byte.

pub fn as_c_fixed_str(&self) -> &CFixedStr

Extracts a CFixedStr slice containing the entire buffer.

pub fn as_c_fixed_str_mut(&mut self) -> &mut CFixedStr

Extracts a mutable CFixedStr slice containing the entire buffer.

pub fn into_boxed_c_fixed_str(self) -> Box<CFixedStr>

Converts this CFixedString into a boxed CFixedStr

Methods from Deref<Target = CFixedStr>

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

Returns the inner pointer to this CFixedStr.

Safety

It is your responsibility to make sure the underlying memory is not freed to early.

pub fn as_mut_ptr(&mut self) -> *mut c_char

Returns the inner pointer to this mutable CFixedStr.

Safety

It is your responsibility to make sure the underlying memory is not freed to early.

pub fn limit(&self) -> usize

Returns the limit of this CFixedStr. This corresponds to the longest possible string that could be stored here.

pub fn len(&self) -> usize

Returns the length of the CFixedStr. This operation takes linear time.

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

Coverts this CFixedStr to a byte slice. The length of the slice is equal to the length of the string up to but not including the first null byte.

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

Coverts this CFixedStr to a mutable byte slice. The length of the slice is equal to the length of the string up to but not including the first null byte.

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

Coverts this CFixedStr to a byte slice. The length of the slice is equal to the length of the string up to and including the first null byte, if it exists.

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

Coverts this CFixedStr to a mutable byte slice. The length of the slice is equal to the length of the string up to and including the first null byte, if it exists.

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

Coverts this CFixedStr to a byte slice. The length of the slice is equal to the limit of the CFixedStr.

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

Coverts this CFixedStr to a mutable byte slice. The length of the slice is equal to the limit of the CFixedStr.

pub fn to_str(&self) -> Result<&str, Utf8Error>

Yields a &str slice if the CFixedStr contains valid UTF-8.

This function will calculate the length of this string and check for UTF-8 validity, and then return the &str if it’s valid.

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

Converts a CFixedStr into a Cow.

This function will calculate the length of this string and then return the resulting slice as a Cow<str>, replacing any invalid UTF-8 sequences with U+FFFD REPLACEMENT CHARACTER.

pub fn to_c_str(&self) -> Cow<'_, CStr>

Converts a CFixedStr into a Cow.

This function will calculate the length of this string, and then ensure it has a terminating null byte. If a null byte is already present, the Borrowed variant can be returned.

Trait Implementations

impl AsRef<CFixedStr> for CFixedString

fn as_ref(&self) -> &CFixedStr

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<CFixedStr> for CFixedString

fn borrow(&self) -> &CFixedStr

Immutably borrows from an owned value.

impl Clone for CFixedString

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CFixedString

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

Formats the value using the given formatter.

impl Default for CFixedString

fn default() -> CFixedString

Returns the “default value” for a type.

impl Deref for CFixedString

type Target = CFixedStr

The resulting type after dereferencing.

fn deref(&self) -> &CFixedStr

Dereferences the value.

impl DerefMut for CFixedString

fn deref_mut(&mut self) -> &mut CFixedStr

Mutably dereferences the value.

impl Drop for CFixedString

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a CFixedStr> for CFixedString

fn from(s: &'a CFixedStr) -> CFixedString

Converts to this type from the input type.

impl From<CFixedString> for Vec<u8>

fn from(s: CFixedString) -> Vec<u8>

Converts to this type from the input type.

impl Hash for CFixedString

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<RangeFull> for CFixedString

type Output = CFixedStr

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &CFixedStr

Performs the indexing (container[index]) operation.

impl IndexMut<RangeFull> for CFixedString

fn index_mut(&mut self, _index: RangeFull) -> &mut CFixedStr

Performs the mutable indexing (container[index]) operation.

impl Ord for CFixedString

fn cmp(&self, other: &CFixedString) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CFixedString

fn eq(&self, other: &CFixedString) -> 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 PartialOrd for CFixedString

fn partial_cmp(&self, other: &CFixedString) -> 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 Eq for CFixedString