Struct PluginIDOwned 

pub struct PluginIDOwned { /* private fields */ }

An owned version of PluginID that can be owned and has optional serialization support with serde.

This type wraps a static string reference and provides implementations for conversion to/from PluginID, as well as serialization support when the serde feature is enabled.

This type is particularly useful when working with serialization frameworks, as it allows plugin identifiers to be properly serialized and deserialized.

If you deserialize a string into this datastructure, please note that this uses an internal leak mechanism (String::leak) to make sure that the actual data of the plugin id will always exist (making it 'static). That means that you may take up more memory than expected if you deserialize huge amoungs of plugin ids.

Examples

use steckrs::{PluginIDOwned, PluginID};

let plugin_id: PluginID = "my_plugin";

// Create from owned id
let id = PluginIDOwned::from(plugin_id);

// Convert back to a PluginID
let plugin_id2: PluginID = id.into();

assert_eq!(plugin_id, plugin_id2);

Serialization

When the serde feature is enabled, this type implements Serialize and Deserialize. Note that deserialization involves a memory leak, as the string is converted to a &'static str by leaking memory (to make sure it is always existing in memory).

The leaking is using safe rust with String::leak.

Implementations

impl PluginIDOwned

pub fn id(&self) -> PluginID

Get the inner PluginID

Trait Implementations

impl Clone for PluginIDOwned

fn clone(&self) -> PluginIDOwned

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginIDOwned

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginIDOwned

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PluginIDOwned

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

Formats the value using the given formatter.

impl From<&PluginIDOwned> for PluginID

fn from(value: &PluginIDOwned) -> Self

Converts to this type from the input type.

impl From<&'static str> for PluginIDOwned

fn from(value: PluginID) -> Self

Converts to this type from the input type.

impl From<PluginIDOwned> for PluginID

fn from(value: PluginIDOwned) -> Self

Converts to this type from the input type.

impl Hash for PluginIDOwned

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 Ord for PluginIDOwned

fn cmp(&self, other: &PluginIDOwned) -> 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 for PluginIDOwned

fn eq(&self, other: &PluginIDOwned) -> 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 PartialOrd for PluginIDOwned

fn partial_cmp(&self, other: &PluginIDOwned) -> 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 Serialize for PluginIDOwned

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PluginIDOwned

impl StructuralPartialEq for PluginIDOwned