Struct oaidl::Variant

pub struct Variant<D, T>where
    D: VariantExt<T>,{ /* private fields */ }

Container for variant-compatible types. Wrap them with this so that the output VARIANT structure has vt == VT_VARIANT and the data is a *mut VARIANT.

Example

extern crate oaidl;
 
use oaidl::{ConversionError, Variant, VariantExt};
 
fn main() -> Result<(), ConversionError> {
    let val = 1337u16;
    let val = Variant::wrap(val);
    // convert into a Ptr<VARIANT> as per usual. 
    Ok(())
}

Implementations

impl<D, T> Variant<D, T>where D: VariantExt<T>,

pub fn wrap(d: D) -> Self

Associated method to wrap a VariantExt compatible type D into a Variant

pub fn unwrap(self) -> D

Consumes self to return the inner data of type D where D: VariantExt<T>

Trait Implementations

impl<D, T: Clone> Clone for Variant<D, T>where D: VariantExt<T> + Clone,

fn clone(&self) -> Variant<D, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D, T: Debug> Debug for Variant<D, T>where D: VariantExt<T> + Debug,

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

Formats the value using the given formatter.

impl<D, T: Hash> Hash for Variant<D, T>where D: VariantExt<T> + Hash,

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<D, T: Ord> Ord for Variant<D, T>where D: VariantExt<T> + Ord,

fn cmp(&self, other: &Variant<D, T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<D, T: PartialEq> PartialEq<Variant<D, T>> for Variant<D, T>where D: VariantExt<T> + PartialEq,

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

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

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.

impl<D, T: PartialOrd> PartialOrd<Variant<D, T>> for Variant<D, T>where D: VariantExt<T> + PartialOrd,

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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

fn try_convert(ptr: Ptr<VARIANT>) -> Result<Self, ElementError>

Converts a Ptr<VARIANT> to a Variant<D, T> where D: VariantExt<T>

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

fn try_convert(ptr: Ptr<VARIANT>) -> Result<Self, FromVariantError>

Converts a Ptr<VARIANT> to a Variant<D, T> where D: VariantExt<T>

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

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.

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

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.

impl<D, T: Copy> Copy for Variant<D, T>where D: VariantExt<T> + Copy,

impl<D, T: Eq> Eq for Variant<D, T>where D: VariantExt<T> + Eq,

impl<D, T> SafeArrayElement for Variant<D, T>where D: VariantExt<T>,

SafeArrayElementimpl for ['Variant<D,T>']. This allows it to be converted into SAFEARRAY with vt =VT_VARIANT. This overrides the default impl of from_safearrayandinto_safearraybecause*mut VARIANTdoesn't need an additional indirection to be put into aSAFEARRAY`.

impl<D, T> StructuralEq for Variant<D, T>where D: VariantExt<T>,

impl<D, T> StructuralPartialEq for Variant<D, T>where D: VariantExt<T>,