Skip to main content

BorrowedStr

Struct BorrowedStr 

Source
pub struct BorrowedStr<'a> {
    pub ptr: *const u8,
    pub len: usize,
    /* private fields */
}
Expand description

A borrowed UTF-8 string with a lifetime tied to the producer’s storage.

Use this for 'static strings baked into a plug-in’s manifest (type names, version strings). The host reads through the pointer while the producing library is loaded; in v1 that is the process lifetime, since plug-ins are not unloaded.

Fields§

§ptr: *const u8§len: usize

Implementations§

Source§

impl<'a> BorrowedStr<'a>

Source

pub const fn empty() -> Self

Returns an empty borrowed string.

Source

pub const fn from_str(s: &'a str) -> Self

Wraps a Rust string slice as a borrowed boundary string.

Source

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

Converts the borrowed string back to a &str.

§Safety

The caller must ensure the producing storage is still live and the bytes are valid UTF-8.

Trait Implementations§

Source§

impl<'a> Clone for BorrowedStr<'a>

Source§

fn clone(&self) -> BorrowedStr<'a>

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<'a> Copy for BorrowedStr<'a>

Source§

impl Debug for BorrowedStr<'_>

Source§

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

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

impl Send for BorrowedStr<'_>

SAFETY: BorrowedStr is just a pointer + length; sending it across threads is sound as long as the underlying storage outlives the use. In v1 the storage is process-lifetime static memory in the producing library.

Source§

impl Sync for BorrowedStr<'_>

SAFETY: see Send impl.

Auto Trait Implementations§

§

impl<'a> Freeze for BorrowedStr<'a>

§

impl<'a> RefUnwindSafe for BorrowedStr<'a>

§

impl<'a> Unpin for BorrowedStr<'a>

§

impl<'a> UnsafeUnpin for BorrowedStr<'a>

§

impl<'a> UnwindSafe for BorrowedStr<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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, 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.