Skip to main content

CStrPtr

Struct CStrPtr 

Source
pub struct CStrPtr(/* private fields */);
Expand description

Simple wrapper to treat a raw pointer to an array of C-style strings as a AsCStrArray

This is useful for passing raw pointers obtained from other sources (e.g., FFI) to functions that expect an AsCStrArray. However, it is the caller’s responsibility to ensure that the pointer validly points to a null-terminated array of pointers to valid C-style strings, and that the array and strings remain valid for the required lifetime. This wrapper does not take ownership of the array or strings.

You should prefer BorrowedCStrs or OwnedCStrs over this type when possible, as they provide ownership and lifetime guarantees for the strings.

Implementations§

Source§

impl CStrPtr

Source

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

Create a new CStrPtr from a raw pointer to an array of C-style strings.

The given pointer is directly returned by the as_ptr method.

§Safety

The caller must ensure that ptr points to a valid null-terminated array of pointers to valid C-style strings. The array and strings must remain valid and unmodified until the CStrPtr is dropped.

Trait Implementations§

Source§

impl AsCStrArray for CStrPtr

Source§

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

Returns a pointer to the array of C-style strings. Read more
Source§

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

Returns a pointer to the array of C-style strings. Read more
Source§

fn to_vec(&self) -> Vec<CString>

Constructs a Vec<CString> from the array of C-style strings. Read more
Source§

impl Clone for CStrPtr

Source§

fn clone(&self) -> CStrPtr

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CStrPtr

Source§

impl Debug for CStrPtr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CStrPtr

Source§

impl Hash for CStrPtr

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for CStrPtr

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for CStrPtr

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl PartialOrd for CStrPtr

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for CStrPtr

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoCStrArray for T
where T: AsCStrArray,

Source§

type CStrArray = T

The type that self can be converted into, which must implement AsCStrArray.
Source§

fn into_c_str_array(self) -> <T as IntoCStrArray>::CStrArray

Converts self into a type that implements AsCStrArray.
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.