Struct HCLIPBOARD

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

Available on crate feature user only.

Handle to the clipboard.

This handle doesn’t exist natively, it’s just an abstraction to safely group the related clipboard operations.

Implementations

impl HCLIPBOARD

pub const unsafe fn from_ptr(p: *mut c_void) -> Self

Constructs a new handle object by wrapping a pointer.

This method can be used as an escape hatch to interoperate with other libraries.

Safety

Be sure the pointer has the correct type and isn’t owned by anyone else, otherwise you may cause memory access violations.

pub const unsafe fn raw_copy(&self) -> Self

Returns a raw copy of the underlying handle pointer.

Safety

As the name implies, raw_copy returns a raw copy of the handle, so closing one of the copies won’t close the others. This means a handle can be used after it has been closed, what can lead to errors and undefined behavior. Even worse: sometimes Windows reuses handle values, so you can call a method on a completely different handle type, what can be catastrophic.

However, in some cases the Windows API demands a copy of the handle – raw_copy is an escape hatch to fill this gap.

pub const unsafe fn as_mut(&mut self) -> &mut *mut c_void

Returns a mutable reference to the underlying raw pointer.

This method can be used as an escape hatch to interoperate with other libraries.

Safety

This method exposes the raw pointer used by raw Windows calls. It’s an opaque pointer to an internal Windows structure, and no dereferencings should be attempted.

pub const fn ptr(&self) -> *mut c_void

Returns the underlying raw pointer.

This method exposes the raw pointer used by raw Windows calls. It’s an opaque pointer to an internal Windows structure, and no dereferencings should be attempted.

This method can be used as an escape hatch to interoperate with other libraries.

impl HCLIPBOARD

pub fn EmptyClipboard(&self) -> SysResult<()>

EmptyClipboard function.

pub fn GetClipboardData(&self, format: CF) -> SysResult<Vec<u8>>

GetClipboardData function.

Calls HGLOBAL::GlobalSize and HGLOBAL::GlobalLock internally to retrieve a copy of the raw clipboard data.

Note that you should not trust the clipboard format – the binary data can be anything, despite what the format says. Be careful when parsing the binary into your desired format.

Examples

use winsafe::{self as w, prelude::*, co};

let hclip = w::HWND::NULL.OpenClipboard()?;
let data = hclip.GetClipboardData(co::CF::TEXT)?;

pub fn GetClipboardSequenceNumber(&self) -> u32

GetClipboardSequenceNumber function.

pub fn SetClipboardData(&self, format: CF, data: &[u8]) -> SysResult<()>

SetClipboardData function.

Calls HGLOBAL::GlobalAlloc and HGLOBAL::GlobalLock internally before copying the data into the clipboard.

Examples

use winsafe::{self as w, prelude::*, co};

let hclip = w::HWND::NULL.OpenClipboard()?;

let str_nullt = "foo"
    .as_bytes()
    .iter()
    .map(|ch| *ch)
    .chain(std::iter::once(0)) // null-terminated
    .collect::<Vec<_>>();

hclip.SetClipboardData(co::CF::TEXT, &str_nullt)?;

Trait Implementations

impl Debug for HCLIPBOARD

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

Formats the value using the given formatter.

impl Display for HCLIPBOARD

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

Formats the value using the given formatter.

impl Handle for HCLIPBOARD

const NULL: Self

Available on crate feature kernel only.

The null, uninitialized handle; equals to 0.

const INVALID: Self

Available on crate feature kernel only.

The invalid handle; equals to -1.

unsafe fn from_ptr(p: *mut c_void) -> Self

Available on crate feature kernel only.

Constructs a new handle object by wrapping a pointer.

unsafe fn raw_copy(&self) -> Self

Available on crate feature kernel only.

Returns a raw copy of the underlying handle pointer.

unsafe fn as_mut(&mut self) -> &mut *mut c_void

Available on crate feature kernel only.

Returns a mutable reference to the underlying raw pointer.

fn ptr(&self) -> *mut c_void

Available on crate feature kernel only.

Returns the underlying raw pointer.

fn as_opt(&self) -> Option<&Self>

Available on crate feature kernel only.

Returns None if the handle is null or invalid, otherwise returns Some(&self).

impl Hash for HCLIPBOARD

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 LowerHex for HCLIPBOARD

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

Formats the value using the given formatter.

impl PartialEq for HCLIPBOARD

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

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

Formats the value using the given formatter.

impl Eq for HCLIPBOARD

impl Send for HCLIPBOARD

impl StructuralPartialEq for HCLIPBOARD