Struct CString

pub struct CString<'a> { /* private fields */ }

Type representing a C-compatible string.

Implementations

impl<'a> CString<'a>

pub fn new(s: &'a str) -> Result<CString<'a>, Error>

Constructs a new CString from a string slice

The caller MUST ensure that there is a trailing NULL to terminate the string. To make this easier, the cstr! macro is provided.

CStrings MUST NOT have any non-ASCII characters, even extended ASCII characters aren’t allowed.

Examples

use rcstring::CString;

let cs = CString::new("foo\0").unwrap();

pub unsafe fn from_raw(ptr: *const c_char) -> Result<CString<'a>, Error>

Converts an exising raw pointer to a string and converts it to a CString with a length determined by an internal strlen implementation.

pub unsafe fn into_raw(&self) -> *const c_char

Returns a mutable pointer to a CString for use in functions taking a classic C string

pub fn len(&self) -> usize

Returns length of string, including trailing NULL

Trait Implementations

impl<'a> Ord for CString<'a>

fn cmp(&self, other: &CString<'_>) -> 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<'a> PartialEq for CString<'a>

fn eq(&self, other: &CString<'_>) -> bool

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

fn ne(&self, other: &CString<'_>) -> bool

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

impl<'a> PartialOrd for CString<'a>

fn partial_cmp(&self, other: &CString<'_>) -> Option<Ordering>

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

fn le(&self, other: &CString<'_>) -> bool

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

fn ge(&self, other: &CString<'_>) -> bool

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

fn lt(&self, other: &CString<'_>) -> bool

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

fn gt(&self, other: &CString<'_>) -> bool

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

impl<'a> Eq for CString<'a>