Struct ObjectTransferHandler

pub struct ObjectTransferHandler {
    pub source: u64,
    pub receiver: u64,
    pub metadata: VirtualObjectMetadata,
    pub orientation: ObjectTransferOrientation,
    pub inner: ObjectTransferHandlerInner,
    /* private fields */
}

Fields

source: u64

receiver: u64

metadata: VirtualObjectMetadata

orientation: ObjectTransferOrientation

inner: ObjectTransferHandlerInner

Implementations

impl ObjectTransferHandler

pub fn new( source: u64, receiver: u64, metadata: VirtualObjectMetadata, orientation: ObjectTransferOrientation, start_recv_tx: Option<Sender<bool>>, ) -> (ObjectTransferHandler, UnboundedSender<ObjectTransferStatus>)

pub async fn exhaust_stream(&mut self) -> Result<Option<PathBuf>, AccountError>

Exhausts the steam, independently of the orientation If the orientation is Sender, this will return no path If the orientation is Receiver, this will return the path of the received file

pub async fn receive_file(&mut self) -> Result<PathBuf, AccountError>

Receives the file, exhausting the underlying stream and returning the save path after completion.

If the orientation is Sender, this will return an error

pub async fn transfer_file(&mut self) -> Result<(), AccountError>

Transfers the file, exhausting the underlying stream

If the orientation is Receiver, this will return an error

pub fn accept(&mut self) -> Result<(), AccountError>

When the local handle type is for a Receiver, the receiver must accept the transfer before receiving the data

pub fn decline(&mut self) -> Result<(), AccountError>

When the local handle type is for a Receiver, the receiver can deny a request

Trait Implementations

impl Debug for ObjectTransferHandler

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

Formats the value using the given formatter.

impl Deref for ObjectTransferHandler

type Target = ObjectTransferHandlerInner

The resulting type after dereferencing.

fn deref(&self) -> &<ObjectTransferHandler as Deref>::Target

Dereferences the value.

impl DerefMut for ObjectTransferHandler

fn deref_mut(&mut self) -> &mut <ObjectTransferHandler as Deref>::Target

Mutably dereferences the value.