Struct oaidl::Ptr

source ·
pub struct Ptr<T> { /* private fields */ }
Expand description

Convenience type for holding value of *mut T Mostly just a projection of NonNull<T> functionality

Implementations§

source§

impl<T> Ptr<T>

source

pub fn new(p: NonNull<T>) -> Ptr<T>

Wraps a valid NonNull<T> NonNull<T>: https://doc.rust-lang.org/nightly/core/ptr/struct.NonNull.html

source

pub fn with_checked(p: *mut T) -> Option<Ptr<T>>

Checks a *mut T for null and wraps it up for easier handling.

source

pub fn as_ptr(&self) -> *mut T

Get inner ptr

source

pub unsafe fn as_ref(&self) -> &T

Get inner reference

Safety

The underlying .as_ref call is unsafe so this is unsafe as well, in order to propagate the unsafety invariant forward.

The lifetime of the provided reference is tied to self.

If you need an unbound lifetime, use &*my_ptr.as_ptr() instead.

source

pub fn cast<U>(self) -> Ptr<U>

Cast a Ptr<T> to Ptr<U>

Trait Implementations§

source§

impl<T: Clone> Clone for Ptr<T>

source§

fn clone(&self) -> Self

Returns a copy 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<T: Debug> Debug for Ptr<T>

source§

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

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

impl<T> From<NonNull<T>> for Ptr<T>

source§

fn from(nn: NonNull<T>) -> Self

Free, zero-allocation conversion from NonNull<T>

source§

impl<T: Hash> Hash for Ptr<T>

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<T> Into<NonNull<T>> for Ptr<T>

source§

fn into(self) -> NonNull<T>

Need to use Into because of orphan rules

source§

impl<T: PartialEq> PartialEq<Ptr<T>> for Ptr<T>

source§

fn eq(&self, other: &Ptr<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: PartialOrd> PartialOrd<Ptr<T>> for Ptr<T>

source§

fn partial_cmp(&self, other: &Ptr<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<T> Pointer for Ptr<T>

source§

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

Formats Ptr<T> as a pointer value (ie, hexadecimal)

source§

impl TryConvert<Ptr<IDispatch>, ElementError> for *mut IDispatch

source§

fn try_convert(p: Ptr<IDispatch>) -> Result<Self, ElementError>

Unwraps the Ptr with [as_ptr()]

source§

impl TryConvert<Ptr<IUnknown>, ElementError> for *mut IUnknown

source§

fn try_convert(p: Ptr<IUnknown>) -> Result<Self, ElementError>

Unwraps the Ptr with [as_ptr()]

source§

impl<D, T> TryConvert<Ptr<VARIANT>, ElementError> for Variant<D, T>where D: VariantExt<T>,

source§

impl<D, T> TryConvert<Ptr<VARIANT>, FromVariantError> for Variant<D, T>where D: VariantExt<T>,

source§

impl<D, T> TryConvert<Variant<D, T>, ElementError> for Ptr<VARIANT>where D: VariantExt<T>,

source§

fn try_convert(v: Variant<D, T>) -> Result<Self, ElementError>

Converts a Variant<D, T> to a Ptr<VARIANT> where D: VariantExt<T> This converts the value inside Variant into a Ptr which is then stuffed inside a containing variant by the caller of the method.

source§

impl<D, T> TryConvert<Variant<D, T>, IntoVariantError> for Ptr<VARIANT>where D: VariantExt<T>,

source§

fn try_convert(v: Variant<D, T>) -> Result<Self, IntoVariantError>

Converts a Variant<D, T> to a Ptr<VARIANT> where D: VariantExt<T> This converts the value inside Variant into a Ptr which is then stuffed inside a containing variant by the caller of the method.

source§

impl<T: Copy> Copy for Ptr<T>

source§

impl<T: Eq> Eq for Ptr<T>

source§

impl SafeArrayElement for Ptr<IDispatch>

SafeArrayElementimpl for ['Ptr<IDispatch>']. This allows it to be converted into SAFEARRAY with vt =VT_DISPATCH. This overrides the default impl of from_safearrayandinto_safearray` because *mut IDispatch doesn’t need an additional indirection to be put into a SAFEARRAY.

source§

impl SafeArrayElement for Ptr<IUnknown>

SafeArrayElementimpl for ['Ptr<IUnknown>']. This allows it to be converted into SAFEARRAY with vt =VT_UNKNOWN. This overrides the default impl of from_safearrayandinto_safearray` because *mut IUnknown doesn’t need an additional indirection to be put into a SAFEARRAY.

source§

impl<T> StructuralEq for Ptr<T>

source§

impl<T> StructuralPartialEq for Ptr<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Ptr<T>where T: RefUnwindSafe,

§

impl<T> !Send for Ptr<T>

§

impl<T> !Sync for Ptr<T>

§

impl<T> Unpin for Ptr<T>

§

impl<T> UnwindSafe for Ptr<T>where T: RefUnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

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, F> TryConvert<T, F> for Twhere T: From<T>, F: Fail,

source§

fn try_convert(val: T) -> Result<T, F>

Blanket TryConvert implementation wherever a From is implemented for T. (Which is all types.) This avoids repetitive code. The compiler monomorphizes the code for F. And because its always an Ok, should optimize this code away.

source§

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

§

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 Twhere U: TryFrom<T>,

§

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.
source§

impl<OutTy, InTy> VariantExt<InTy> for OutTywhere OutTy: TryConvert<InTy, FromVariantError> + VariantAccess<Field = InTy>, InTy: TryConvert<OutTy, IntoVariantError>,

source§

const VARTYPE: u32 = const VARTYPE: u32 = OutTy::VTYPE;

VARTYPE constant value for the type
source§

fn from_variant(pvar: Ptr<VARIANT>) -> Result<OutTy, FromVariantError>

Call this associated function on a Ptr<VARIANT> to obtain a value T
source§

fn into_variant(value: OutTy) -> Result<Ptr<VARIANT>, IntoVariantError>

Convert a value of type T into a Ptr<VARIANT>