Skip to main content

FName

Struct FName 

Source
pub struct FName(pub FNameHandle);
Expand description

A UE FName value. Copy-able, hashable, and comparable.

FName is UE’s interned string type — cheap to copy and compare, but creation and string conversion require FFI calls.

Tuple Fields§

§0: FNameHandle

Implementations§

Source§

impl FName

Source

pub const NONE: FName

The “None” name (index 0).

Source

pub fn new(name: &str) -> Self

Create an FName from a string.

Source

pub fn handle(&self) -> FNameHandle

Get the underlying FFI handle.

Source

pub fn is_none(&self) -> bool

Check if this is the “None” name.

Source

pub fn to_string_lossy(&self) -> String

Convert to a String. Returns an error only if the FFI call fails.

Trait Implementations§

Source§

impl Clone for FName

Source§

fn clone(&self) -> FName

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 FName

Source§

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

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

impl Default for FName

Source§

fn default() -> Self

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

impl Display for FName

Source§

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

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

impl From<&str> for FName

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<FName> for FNameHandle

Source§

fn from(name: FName) -> FNameHandle

Converts to this type from the input type.
Source§

impl From<FNameHandle> for FName

Source§

fn from(handle: FNameHandle) -> FName

Converts to this type from the input type.
Source§

impl Hash for FName

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 PartialEq<&str> for FName

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 PartialEq for FName

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Copy for FName

Source§

impl Eq for FName

Source§

impl StructuralPartialEq for FName

Auto Trait Implementations§

§

impl Freeze for FName

§

impl RefUnwindSafe for FName

§

impl Send for FName

§

impl Sync for FName

§

impl Unpin for FName

§

impl UnsafeUnpin for FName

§

impl UnwindSafe for FName

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, 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.