Struct abi_stable::prefix_type::WithMetadata_ [−][src]
#[repr(C)]pub struct WithMetadata_<T, P> {
pub metadata: PrefixMetadata<T, P>,
pub value: AlignToUsize<T>,
// some fields omitted
}
Expand description
Wraps a type along with its prefix-type-related metadata, so that it can be converted to its prefix.
Example
This example demonstrates how you can construct a WithMetadata
and
convert it to a prefix type pointer (Module_Ref
in this case).
You can look at the PrefixRef
docs for
a more detailed example.
use abi_stable::{
for_examples::{Module, Module_Ref},
prefix_type::{PrefixRef, PrefixTypeTrait, WithMetadata},
std_types::{RSome, RStr},
staticref,
};
const WITH_META: &WithMetadata<Module> = &WithMetadata::new(
PrefixTypeTrait::METADATA,
Module {
first: RSome(66),
second: RStr::from_str("lore"),
third: 333,
},
);
const MOD: Module_Ref = Module_Ref(WITH_META.static_as_prefix());
assert_eq!(MOD.first(), RSome(66));
assert_eq!(MOD.second().as_str(), "lore");
Fields
metadata: PrefixMetadata<T, P>
value: AlignToUsize<T>
The wrapped value.
Implementations
Constructs this with WithMetadata::new(PrefixTypeTrait::METADATA, value)
This takes in the metadata: PrefixMetadata<T>
parameter as a
workaround for const fn
not allowing trait bounds,
which in this case is PrefixTypeTrait
.
Constructs a PrefixRef
from this
.
Safety
You must enture that this WithMetadata
lives for the entire program’s lifetime.
Constructs a PrefixRef
from self
.
Safety
You must ensure that self
lives for the entire program’s lifetime.
Alternative
For a safe equivalent of this, you can use StaticRef::as_prefix
.
Constructs a PrefixRef
from self
.
Example
use abi_stable::{
for_examples::{Module, Module_Ref},
prefix_type::{PrefixRef, PrefixTypeTrait, WithMetadata},
std_types::{RSome, RStr},
};
const WITH_META: &WithMetadata<Module> = &WithMetadata::new(
PrefixTypeTrait::METADATA,
Module {
first: RSome(13),
second: RStr::from_str("foo"),
third: 100,
},
);
const MOD: Module_Ref = Module_Ref(WITH_META.static_as_prefix());
assert_eq!(MOD.first(), RSome(13));
assert_eq!(MOD.second().as_str(), "foo");
Auto Trait Implementations
impl<T, P> RefUnwindSafe for WithMetadata_<T, P> where
P: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, P> Send for WithMetadata_<T, P> where
P: Send,
T: Send,
impl<T, P> Sync for WithMetadata_<T, P> where
P: Sync,
T: Sync,
impl<T, P> Unpin for WithMetadata_<T, P> where
P: Unpin,
T: Unpin,
impl<T, P> UnwindSafe for WithMetadata_<T, P> where
P: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
type ForSelf = WithMetadata_<T, T>
type ForSelf = WithMetadata_<T, T>
This is always WithMetadata_<Self, Self>
Compares the address of self
with the address of other
. Read more
Emulates the pipeline operator, allowing method syntax in more places. Read more
The same as piped
except that the function takes &Self
Useful for functions that take &Self
instead of Self
. Read more
The same as piped
, except that the function takes &mut Self
.
Useful for functions that take &mut Self
instead of Self
. Read more
Mutates self using a closure taking self by mutable reference, passing it along the method chain. Read more
Observes the value of self, passing it along unmodified. Useful in long method chains. Read more
Performs a conversion with Into
.
using the turbofish .into_::<_>()
syntax. Read more
Performs a reference to reference conversion with AsRef
,
using the turbofish .as_ref_::<_>()
syntax. Read more
Performs a mutable reference to mutable reference conversion with AsMut
,
using the turbofish .as_mut_::<_>()
syntax. Read more
unsafe fn transmute_element<T>(
self
) -> <Self as CanTransmuteElement<T>>::TransmutedPtr where
Self: CanTransmuteElement<T>,
unsafe fn transmute_element<T>(
self
) -> <Self as CanTransmuteElement<T>>::TransmutedPtr where
Self: CanTransmuteElement<T>,
Transmutes the element type of this pointer.. Read more
type Type = T
type Type = T
This is always Self
.
Converts a value back to the original type.
Converts a mutable reference back to the original type.
Converts a box back to the original type.
Converts an Arc back to the original type. Read more
Converts an Rc back to the original type. Read more
Converts a value back to the original type.
Converts a reference back to the original type.
Converts a mutable reference back to the original type.
Converts a box back to the original type.
Converts an Arc back to the original type.
Converts an Rc back to the original type.