Skip to main content

InternedString

Struct InternedString

pub struct InternedString { /* private fields */ }

Expand description

A binary-stable, transparent representation of fxt::InternedString.

This structure has the exact same memory layout as the C++ fxt::InternedString (which is a single const char* pointer pointing to a null-terminated string).

Placing instances of this structure in the special linker section __fxt_interned_string_table allows them to sit contiguous alongside C++’s own interned strings in the global string table segment, meaning their trace-ID calculations (this - section_begin) are safe, exact, and valid.

Implementations§

impl InternedString

pub const unsafe fn new_raw(ptr: *const u8) -> InternedString

Creates a new InternedString from a raw pointer.

§Safety

The caller must ensure that the pointer points to a null-terminated string with static storage duration (’static).

pub const fn as_ptr(&self) -> *const u8

Returns the raw pointer to the null-terminated string.

pub fn as_c_str(&self) -> &'static CStr

Returns the static name as a safe, null-terminated C string reference.

pub fn id(&self) -> u16

Returns the numeric trace ID for this interned string.

Trait Implementations§

impl Send for InternedString

impl Sync for InternedString

Auto Trait Implementations§

impl Freeze for InternedString

impl RefUnwindSafe for InternedString

impl Unpin for InternedString

impl UnsafeUnpin for InternedString

impl UnwindSafe for InternedString

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Init<T> for T

unsafe fn __init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> PinInit<T> for T

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

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

type Target = T

The target type of the pointer.

fn to_mut_ptr(&self) -> *mut T

Casts the reference to a mutable raw pointer.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.