Skip to main content

RbString

Struct RbString 

Source
#[repr(C)]
pub struct RbString { pub len: u32, pub data: *const u8, }
Expand description

FFI-safe borrowed string reference

This is a view into a UTF-8 string that the caller owns. The string data must remain valid for the duration of the FFI call.

§Memory Layout

+--------+--------+
|  len   |  data  |
| (u32)  | (*u8)  |
+--------+--------+

§Invariants

  • If data is non-null, it must point to valid UTF-8 bytes
  • If data is non-null, it must be null-terminated (for C compatibility)
  • len is the byte length, NOT including the null terminator
  • If len == 0 and data == null, the string is considered “not present” (None)
  • If len == 0 and data != null, the string is an empty string

Fields§

§len: u32

Length in bytes (excluding null terminator)

§data: *const u8

Pointer to null-terminated UTF-8 data

Implementations§

Source§

impl RbString

Source

pub const fn none() -> Self

Create an empty/absent string (represents None)

Source

pub const fn from_static(s: &'static str) -> Self

Create a string from a static str

§Safety

The string must be null-terminated. Use this only with string literals or strings known to have a null terminator.

Source

pub fn is_present(&self) -> bool

Check if this string is present (not None)

Source

pub fn is_empty(&self) -> bool

Check if this string is empty

Source

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

Convert to a Rust string slice

§Safety
  • data must be valid for reads of len bytes
  • data must point to valid UTF-8
  • The memory must not be modified during the lifetime of the returned slice
Source

pub unsafe fn to_string(&self) -> Option<String>

Convert to a Rust String (copies data)

§Safety

Same requirements as as_str

Trait Implementations§

Source§

impl Clone for RbString

Source§

fn clone(&self) -> RbString

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RbString

Source§

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

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

impl Default for RbString

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for RbString

Source§

impl Send for RbString

Source§

impl Sync for RbString

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more