Struct StringPtr

pub struct StringPtr<'a> { /* private fields */ }

StringPtr

C++ Info

• name: hkStringPtr
• type_size: 4(x86)/ 8(x86_64)
• align: 4(x86)/ 8(x86_64)

Null representation

• hkx: It will not be written to the binary data.
• XML: \u{2400}.
• Rust: If it is null then Option::None.(To eliminate the risk of always being null ptr by type)

Deserialization patterns

• hkx(Vec<u8>) -> Struct(str in Cow<'_, str>) => non copy
• xml(String) -> Struct(str in Cow<'_, str>) => non copy
• json: String -> Struct(str in Cow<'_, str>) => non copy

Serialization is alloc

Struct(str) -> (alloc String)

Implementations

impl<'a> StringPtr<'a>

pub const fn new(inner: Option<Cow<'a, str>>) -> Self

Create a new StringPtr

pub fn into_inner(self) -> Option<Cow<'a, str>>

Get inner value.

pub const fn get_ref(&self) -> &Option<Cow<'a, str>>

Get inner ref.

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

Cast str with non copying.

pub const fn from_option(s: Option<Cow<'a, str>>) -> Self

Inner to Self

pub const fn is_null(&self) -> bool

Null pointer or not?

This indicates that no binary data was present.

pub const fn should_write_binary(&self) -> bool

Should the data pointed to by the pointer be written to the binary data or not?

This is an invalid value or not.

pub fn as_str(&self) -> &str

Gets a reference as &str.

Trait Implementations

impl<'a> Clone for StringPtr<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StringPtr<'a>

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

Formats the value using the given formatter.

impl<'a> Default for StringPtr<'a>

fn default() -> StringPtr<'a>

Returns the “default value” for a type.

impl Display for StringPtr<'_>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<'a> From<CString<'a>> for StringPtr<'a>

fn from(value: CString<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for StringPtr<'a>

fn from(value: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<Cow<'a, str>>> for StringPtr<'a>

fn from(inner: Option<Cow<'a, str>>) -> Self

Converts to this type from the input type.

impl<'a> Hash for StringPtr<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for StringPtr<'a>

fn cmp(&self, other: &StringPtr<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&str> for StringPtr<'_>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for StringPtr<'_>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for StringPtr<'_>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq for StringPtr<'a>

fn eq(&self, other: &StringPtr<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for StringPtr<'a>

fn partial_cmp(&self, other: &StringPtr<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for StringPtr<'a>

impl<'a> StructuralPartialEq for StringPtr<'a>