Struct openssh_sftp_client::SharedData

pub struct SharedData<Buffer, Auxiliary = ()>(_);

SharedData contains both the writer and the responses because:

• The overhead of Arc and a separate allocation;
• If the write end of a connection is closed, then openssh implementation of sftp-server would close the read end right away, discarding any unsent but processed or unprocessed responses.

Implementations

impl<Buffer, Auxiliary> SharedData<Buffer, Auxiliary>

pub fn strong_count(&self) -> usize

SharedData is a newtype wrapper for Arc<SharedDataInner>, so this function returns how many Arc there are that referred to the shared data.

pub fn get_auxiliary(&self) -> &Auxiliary

pub fn get_auxiliary_mut(&mut self) -> Option<&mut Auxiliary>

impl<Buffer: Send + Sync, Auxiliary> SharedData<Buffer, Auxiliary>

pub fn create_response_id(&self) -> Id<Buffer>

Create a useable response id.

pub fn try_reserve_id(&self, new_id_cnt: u32) -> bool

Return true if reserve succeeds, false otherwise.

pub fn reserve_id(&self, new_id_cnt: u32)

Return true if reserve succeeds, false otherwise.

pub async fn try_flush(&self) -> Result<bool, Error>

Flush the write buffer.

If another thread is flushing, then Ok(false) will be returned.

Cancel Safety

This function is only cancel safe if WriteEnd::send_write_request_direct or WriteEnd::send_write_request_direct_vectored is not called when this future is cancelled.

Upon cancel, it might only partially flushed out the data, which can be restarted by another thread.

However, if WriteEnd::send_write_request_direct or WriteEnd::send_write_request_direct_vectored is called, then the write data will be interleaved and thus produce undefined behavior.

pub async fn flush(&self) -> Result<(), Error>

Flush the write buffer.

If another thread is flushing, then this function would wait until the other thread is done.

Cancel Safety

This function is only cancel safe if WriteEnd::send_write_request_direct or WriteEnd::send_write_request_direct_vectored is not called when this future is cancelled.

Upon cancel, it might only partially flushed out the data, which can be restarted by another thread.

However, if WriteEnd::send_write_request_direct or WriteEnd::send_write_request_direct_vectored is called, then the write data will be interleaved and thus produce undefined behavior.

Trait Implementations

impl<Buffer, Auxiliary> Clone for SharedData<Buffer, Auxiliary>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Buffer: Debug, Auxiliary: Debug> Debug for SharedData<Buffer, Auxiliary>

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

Formats the value using the given formatter.

impl<Buffer, Auxiliary> Drop for SharedData<Buffer, Auxiliary>

fn drop(&mut self)

Executes the destructor for this type.