Struct BStr

pub struct BStr(/* private fields */);

Represents a borrowed BSTR string.

Implementations

impl BStr

pub unsafe fn from_ptr<'a>(ptr: *const u16) -> &'a BStr

Unsafely creates a BStr from a BSTR pointer.

This function will cast the pointer into a BStr. The provied pointer must be a valid BSTR pointer and must be valid while the BStr is alive. The BStr must also not be moved.

Safety

The parameter must be a valid BSTR pointer. This includes both the memory layout and allocation using BSTR-compatible allocation functions.

In addition to this the pointer must be kept alive while the returned reference is in use.

pub fn as_ptr(&self) -> *const u16

Returns the pointer as a 16-bit wide character pointer.

pub fn len_bytes(&self) -> u32

Returns the string length in bytes.

Does not include the length prefix or the terminating zero. However any zero bytes in the middle of the string are included.

pub fn len(&self) -> u32

Returns the string length in characters.

pub fn is_empty(&self) -> bool

pub fn as_slice(&self) -> &[u8]

Gets the BStr as a slice of 16-bit characters.

pub fn to_string(&self) -> Result<String, FormatError>

Trait Implementations

impl AsRef<BStr> for BStr

fn as_ref(&self) -> &BStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<BStr> for BString

fn as_ref(&self) -> &BStr

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<BStr> for BString

fn borrow(&self) -> &BStr

Immutably borrows from an owned value.

impl Debug for BStr

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

Formats the value using the given formatter.

impl<'a> ExternInput<AutomationTypeSystem> for &'a BStr

type Lease = ()

type Owned = &'a BStr

unsafe fn into_foreign_parameter( self, ) -> ComResult<(Self::ForeignType, Self::Lease)>

Safety

unsafe fn from_foreign_parameter( source: Self::ForeignType, ) -> ComResult<Self::Owned>

Safety

impl<'a> ExternInput<RawTypeSystem> for &'a BStr

type Lease = CString

type Owned = BString

unsafe fn into_foreign_parameter( self, ) -> ComResult<(Self::ForeignType, Self::Lease)>

Safety

unsafe fn from_foreign_parameter( source: Self::ForeignType, ) -> ComResult<Self::Owned>

Safety

impl<'a> ExternType<AutomationTypeSystem> for &'a BStr

type ForeignType = BSTR

impl<'a> ExternType<RawTypeSystem> for &'a BStr

type ForeignType = *mut i8

impl PartialEq for BStr

fn eq(&self, other: &BStr) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToOwned for BStr

type Owned = BString

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for BStr

impl StructuralPartialEq for BStr