Struct FfiSafeStr

#[repr(C)]
pub struct FfiSafeStr { /* private fields */ }

A helper struct for passing rust strings over the ABI boundary.

This type can only be constructed from a valid rust string, so it’s not necessary to validate the utf8 encoding when converting back to &str.

Implementations

impl FfiSafeStr

pub fn len(self) -> usize

pub fn is_empty(self) -> bool

pub unsafe fn from_raw_parts(pointer: NonNull<u8>, len: usize) -> Self

Safety

pointer and len must be correct pointer and length

pub unsafe fn from_utf8_unchecked(bytes: &[u8]) -> Self

Safety

bytes must represent a valid utf8 string.

pub fn into_raw_parts(self) -> (*mut u8, usize)

pub unsafe fn as_str<'a>(self) -> &'a str

Converts self back to a borrowed string &str.

Safety

FfiSafeStr can only be constructed from a valid rust str, so you only need to make sure that the origial str outlives the lifetime 'a.

This should generally be true when borrowing strings owned by the current function and calling a function via FFI, but borrowing global data or data stored within a Rc for example is probably unsafe.

pub unsafe fn as_bytes<'a>(self) -> &'a [u8]

Converts self back to a borrowed string &[u8].

Safety

FfiSafeStr can only be constructed from a valid rust byte slice, so you only need to make sure that the original &[u8] outlives the lifetime 'a.

This should generally be true when borrowing strings owned by the current function and calling a function via FFI, but borrowing global data or data stored within a Rc for example is probably unsafe.

Trait Implementations

impl Clone for FfiSafeStr

fn clone(&self) -> FfiSafeStr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FfiSafeStr

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

Formats the value using the given formatter.

impl Default for FfiSafeStr

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a str> for FfiSafeStr

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl GetStaticEquivalent_ for FfiSafeStr

type StaticEquivalent = _static_FfiSafeStr

The 'static equivalent of Self

impl StableAbi for FfiSafeStr

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.

impl Copy for FfiSafeStr