Struct oaidl::DroppableBString

pub struct DroppableBString { /* private fields */ }

Struct that holds pointer to Sys* allocated memory. It will automatically free the memory via the Sys* functions unless it has been consumed.

Safety

This wraps up a pointer to Sys* allocated memory and will automatically clean up that memory correctly unless the memory has been leaked by consume().

One would use the .consume() method when sending the pointer through FFI.

If you don’t manually free the memory yourself (correctly) or send it to an FFI function that will do so, then it will be leaked memory.

If you have a memory leak and you’re using this type, then check your use of consume.

Example

extern crate oaidl;
extern crate widestring;
 
use oaidl::{BStringError, BStringExt, DroppableBString};
use widestring::U16String;
 
fn main() -> Result<(), BStringError> {
    let s = U16String::from_str("The first step to doing anything is to believe you can do it. See it finished in your mind before you ever start. It takes dark in order to show light.");
    let dbs = s.consume_to_managed_bstr()?;
    drop(dbs); // Correctly deallocates allocated memory.
    Ok(())
}

Implementations

impl DroppableBString

pub unsafe fn consume(&mut self) -> *mut u16

consume() -> *mut u16 returns the contained data while also setting a flag that the data has been consumed. It is your responsibility to manage the memory yourself. Most uses of BSTR in FFI will free the memory for you.

This method is very unsafe to use unless you know how to handle it correctly, hence the unsafe marker.

Trait Implementations

impl Debug for DroppableBString

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

Formats the value using the given formatter.

impl Drop for DroppableBString

fn drop(&mut self)

Handles freeing the allocated BSTR correctly via SysFreeString. The only (safe) way to construct a DroppableBString is via an [allocate_managed_bstr] call.

impl Hash for DroppableBString

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 PartialEq<DroppableBString> for DroppableBString

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

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

impl StructuralEq for DroppableBString

impl StructuralPartialEq for DroppableBString