Struct winsafe::VARIANT

#[repr(C)]
pub struct VARIANT { /* private fields */ }

Available on crate feature oleaut only.

VARIANT struct.

Automatically calls VariantClear when the object goes out of scope.

The Default implementation returns a co::VT::EMPTY value.

Implementations

impl VARIANT

pub fn new_idispatch(val: &impl oleaut_IDispatch) -> Self

Creates a new object holding an IDispatch COM value.

Note that val will be cloned into the VARIANT – that is, IUnknown::AddRef will be called –, so val will remain valid to be used thereafter.

pub fn idispatch<T>(&self) -> Option<T>

where T: oleaut_IDispatch,

If the object holds an IDispatch COM value, returns it, otherwise None.

Note that the returned object will be a clone – that is, IUnknown::AddRef will be called.

pub fn new_iunknown<T>(val: &impl ole_IUnknown) -> Self

Creates a new object holding an IUnknown COM value.

Note that val will be cloned into the VARIANT – that is, IUnknown::AddRef will be called –, so val will remain valid to be used thereafter.

pub fn iunknown<T>(&self) -> Option<T>

where T: ole_IUnknown,

If the object holds an IUnknown COM value, returns it, otherwise None.

Note that the returned object will be a clone – that is, IUnknown::AddRef will be called.

Trait Implementations

impl Default for VARIANT

fn default() -> Self

Returns the “default value” for a type.

impl Drop for VARIANT

fn drop(&mut self)

Executes the destructor for this type.

impl oleaut_Variant for VARIANT

fn raw(&self) -> &[u8; 16]

Returns a reference to the raw data being held.

unsafe fn from_raw(vt: VT, data: &[u8]) -> Self

Creates an object straight from raw data. Up to 16 u8 elements will be actually copied.

fn vt(&self) -> VT

Returns the co::VT variant type currently being held.

fn is_empty(&self) -> bool

Tells whether no value is being held, that is, the variant type is co::VT::EMPTY.

fn is_null(&self) -> bool

Tells whether the object holds an SQL style null, that is, the variant type is co::VT::NULL.

fn new_bool(val: bool) -> Self

where Self: Sized,

Crates a new object holding a bool value.

fn bool(&self) -> Option<bool>

If the object holds a bool value, returns it, otherwise None.

fn new_bstr(val: &str) -> HrResult<Self>

where Self: Sized,

Creates a new object holding a BSTR value.

fn bstr(&self) -> Option<String>

If the object holds a BSTR value, returns it, otherwise None.

fn new_f32(val: f32) -> Self

where Self: Sized,

Creates a new VARIANT holding an f32 value.

fn f32(&self) -> Option<f32>

If the VARIANT holds an f32 value, returns it, otherwise None.

fn new_f64(val: f64) -> Self

where Self: Sized,

Creates a new object holding an f64 value.

fn f64(&self) -> Option<f64>

If the object holds an f64 value, returns it, otherwise None.

fn new_i8(val: i8) -> Self

where Self: Sized,

Creates a new object holding an i8 value.

fn i8(&self) -> Option<i8>

If the object holds an i8 value, returns it, otherwise None.

fn new_i16(val: i16) -> Self

where Self: Sized,

Creates a new object holding an i16 value.

fn i16(&self) -> Option<i16>

If the object holds an i16 value, returns it, otherwise None.

fn new_i32(val: i32) -> Self

where Self: Sized,

Creates a new object holding an i32 value.

fn i32(&self) -> Option<i32>

If the object holds an i32 value, returns it, otherwise None.

fn new_time(val: &SYSTEMTIME) -> SysResult<Self>

where Self: Sized,

Creates a new object holding a date/time value.

fn time(&self) -> Option<SYSTEMTIME>

If the object holds a date/time value, returns it, otherwise None.

fn new_u8(val: u8) -> Self

where Self: Sized,

Creates a new object holding an u8 value.

fn u8(&self) -> Option<u8>

If the object holds an u8 value, returns it, otherwise None.

fn new_u16(val: u16) -> Self

where Self: Sized,

Creates a new object holding an u16 value.

fn u16(&self) -> Option<u16>

If the object holds an u16 value, returns it, otherwise None.

fn new_u32(val: u32) -> Self

where Self: Sized,

Creates a new object holding an u32 value.

fn u32(&self) -> Option<u32>

If the object holds an u32 value, returns it, otherwise None.