Struct smithay_client_toolkit::data_device::DataOffer

pub struct DataOffer {
    pub(crate) offer: WlDataOffer,
    inner: Arc<Mutex<Inner>>,
}

A data offer for receiving data though copy/paste or drag and drop

Fields

offer: WlDataOffer

inner: Arc<Mutex<Inner>>

Implementations

impl DataOffer

pub(crate) fn new(offer: Main<WlDataOffer>) -> DataOffer

pub fn with_mime_types<F, T>(&self, f: F) -> Twhere F: FnOnce(&[String]) -> T,

Access the list of mime types proposed by this offer

pub fn get_available_actions(&self) -> DndAction

Get the list of available actions for this offer

pub fn get_current_action(&self) -> DndAction

Get the currently set final action for this offer

pub fn accept(&self, mime_type: Option<String>)

Accept a mime type for receiving data through this offer

pub fn receive(&self, mime_type: String) -> Result<ReadPipe>

Request to receive the data of a given mime type

You can do this several times, as a reaction to motion of the dnd cursor, or to inspect the data in order to choose your response.

Note that you should not read the contents right away in a blocking way, as you may deadlock your application doing so. At least make sure you flush your events to the server before doing so.

Fails if too many file descriptors were already open and a pipe could not be created.

pub unsafe fn receive_to_fd(&self, mime_type: String, writefd: RawFd)

Receive data to the write end of a raw file descriptor. If you have the read end, you can read from it.

You can do this several times, as a reaction to motion of the dnd cursor, or to inspect the data in order to choose your response.

Note that you should not read the contents right away in a blocking way, as you may deadlock your application doing so. At least make sure you flush your events to the server before doing so.

Safety

The provided file destructor must be a valid FD for writing, and will be closed once the contents are written.

pub fn set_actions(&self, supported: DndAction, preferred: DndAction)

Notify the send and compositor of the dnd actions you accept

You need to provide the set of supported actions, as well as a single preferred action.

pub fn finish(&self)

Notify that you are finished with this offer, and will no longer be using it

Note that it is a protocol error to finish if no action or mime type was accepted.

Trait Implementations

impl Debug for DataOffer

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

Formats the value using the given formatter.

impl Drop for DataOffer

fn drop(&mut self)

Executes the destructor for this type.