Struct openssh_sftp_client_lowlevel::WriteEnd

pub struct WriteEnd<Buffer, Q, Auxiliary = ()> { /* private fields */ }

It is recommended to create at most one WriteEnd per thread using WriteEnd::clone.

Implementations

impl<Buffer, Q, Auxiliary> WriteEnd<Buffer, Q, Auxiliary>

pub fn new(shared_data: SharedData<Buffer, Q, Auxiliary>) -> Self

Create a WriteEnd from SharedData.

pub fn into_shared_data(self) -> SharedData<Buffer, Q, Auxiliary>

Consume the WriteEnd and return the stored SharedData.

impl<Buffer, Q, Auxiliary> WriteEnd<Buffer, Q, Auxiliary>where
    Buffer: Send + Sync,
    Q: Queue,

pub fn send_open_file_request(
    &mut self,
    id: Id<Buffer>,
    params: OpenFileRequest<'_>
) -> Result<AwaitableHandle<Buffer>, Error>

pub fn send_close_request(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>
) -> Result<AwaitableStatus<Buffer>, Error>

pub fn send_read_request(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>,
    offset: u64,
    len: u32,
    buffer: Option<Buffer>
) -> Result<AwaitableData<Buffer>, Error>

• buffer - If set to None or the buffer is not long enough, then crate::Data::AllocatedBox will be returned.

Return crate::Data::Buffer or crate::Data::AllocatedBox if not EOF, otherwise returns crate::Data::Eof.

pub fn send_remove_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableStatus<Buffer>, Error>

pub fn send_rename_request(
    &mut self,
    id: Id<Buffer>,
    oldpath: Cow<'_, Path>,
    newpath: Cow<'_, Path>
) -> Result<AwaitableStatus<Buffer>, Error>

pub fn send_mkdir_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>,
    attrs: FileAttrs
) -> Result<AwaitableStatus<Buffer>, Error>

• attrs - FileAttrs::get_size must be equal to None.

pub fn send_rmdir_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableStatus<Buffer>, Error>

pub fn send_opendir_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableHandle<Buffer>, Error>

pub fn send_readdir_request(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>
) -> Result<AwaitableNameEntries<Buffer>, Error>

Return all entries in the directory specified by the handle, including . and ...

The filename only contains the basename.

pub fn send_stat_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableAttrs<Buffer>, Error>

pub fn send_lstat_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableAttrs<Buffer>, Error>

Does not follow symlink

pub fn send_fstat_request(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>
) -> Result<AwaitableAttrs<Buffer>, Error>

• handle - Must be opened with FileMode::READ.

pub fn send_setstat_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>,
    attrs: FileAttrs
) -> Result<AwaitableStatus<Buffer>, Error>

pub fn send_fsetstat_request(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>,
    attrs: FileAttrs
) -> Result<AwaitableStatus<Buffer>, Error>

• handle - Must be opened with OpenOptions::write set.

pub fn send_readlink_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableName<Buffer>, Error>

pub fn send_realpath_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableName<Buffer>, Error>

pub fn send_symlink_request(
    &mut self,
    id: Id<Buffer>,
    targetpath: Cow<'_, Path>,
    linkpath: Cow<'_, Path>
) -> Result<AwaitableStatus<Buffer>, Error>

Create symlink

pub fn send_limits_request(
    &mut self,
    id: Id<Buffer>
) -> Result<AwaitableLimits<Buffer>, Error>

Return limits of the server

Precondition

Requires Extensions::limits to be true.

pub fn send_expand_path_request(
    &mut self,
    id: Id<Buffer>,
    path: Cow<'_, Path>
) -> Result<AwaitableName<Buffer>, Error>

This supports canonicalisation of relative paths and those that need tilde-expansion, i.e. “~”, “~/…” and “~user/…”.

These paths are expanded using shell-like rules and the resultant path is canonicalised similarly to WriteEnd::send_realpath_request.

Precondition

Requires Extensions::expand_path to be true.

pub fn send_fsync_request(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>
) -> Result<AwaitableStatus<Buffer>, Error>

Precondition

Requires Extensions::fsync to be true.

pub fn send_hardlink_request(
    &mut self,
    id: Id<Buffer>,
    oldpath: Cow<'_, Path>,
    newpath: Cow<'_, Path>
) -> Result<AwaitableStatus<Buffer>, Error>

Precondition

Requires Extensions::hardlink to be true.

pub fn send_posix_rename_request(
    &mut self,
    id: Id<Buffer>,
    oldpath: Cow<'_, Path>,
    newpath: Cow<'_, Path>
) -> Result<AwaitableStatus<Buffer>, Error>

Precondition

Requires Extensions::posix_rename to be true.

pub fn send_copy_data_request(
    &mut self,
    id: Id<Buffer>,
    read_from_handle: Cow<'_, Handle>,
    read_from_offset: u64,
    read_data_length: u64,
    write_to_handle: Cow<'_, Handle>,
    write_to_offset: u64
) -> Result<AwaitableStatus<Buffer>, Error>

The server MUST copy the data exactly as if the client had issued a series of [RequestInner::Read] requests on the read_from_handle starting at read_from_offset and totaling read_data_length bytes, and issued a series of [RequestInner::Write] packets on the write_to_handle, starting at the write_from_offset, and totaling the total number of bytes read by the [RequestInner::Read] packets.

The server SHOULD allow read_from_handle and write_to_handle to be the same handle as long as the range of data is not overlapping. This allows data to efficiently be moved within a file.

If data_length is 0, this imples data should be read until EOF is encountered.

There are no protocol restictions on this operation; however, the server MUST ensure that the user does not exceed quota, etc. The server is, as always, free to complete this operation out of order if it is too large to complete immediately, or to refuse a request that is too large.

Precondition

Requires Extensions::copy_data to be true.

For openssh-portable, this is available from V_9_0_P1.

impl<Buffer, Q, Auxiliary> WriteEnd<Buffer, Q, Auxiliary>where
    Buffer: ToBuffer + Send + Sync + 'static,
    Q: Queue,

pub fn send_write_request_buffered(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>,
    offset: u64,
    data: Cow<'_, [u8]>
) -> Result<AwaitableStatus<Buffer>, Error>

Write will extend the file if writing beyond the end of the file.

It is legal to write way beyond the end of the file, the semantics are to write zeroes from the end of the file to the specified offset and then the data.

On most operating systems, such writes do not allocate disk space but instead leave “holes” in the file.

This function is only suitable for writing small data since it needs to copy the entire data into buffer.

pub fn send_write_request_buffered_vectored(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>,
    offset: u64,
    io_slices: &[IoSlice<'_>]
) -> Result<AwaitableStatus<Buffer>, Error>

Write will extend the file if writing beyond the end of the file.

It is legal to write way beyond the end of the file, the semantics are to write zeroes from the end of the file to the specified offset and then the data.

On most operating systems, such writes do not allocate disk space but instead leave “holes” in the file.

This function is only suitable for writing small data since it needs to copy the entire data into buffer.

pub fn send_write_request_buffered_vectored2(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>,
    offset: u64,
    bufs: &[&[IoSlice<'_>]]
) -> Result<AwaitableStatus<Buffer>, Error>

Write will extend the file if writing beyond the end of the file.

It is legal to write way beyond the end of the file, the semantics are to write zeroes from the end of the file to the specified offset and then the data.

On most operating systems, such writes do not allocate disk space but instead leave “holes” in the file.

This function is only suitable for writing small data since it needs to copy the entire data into buffer.

pub fn send_write_request_zero_copy(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>,
    offset: u64,
    data: &[Bytes]
) -> Result<AwaitableStatus<Buffer>, Error>

Write will extend the file if writing beyond the end of the file.

It is legal to write way beyond the end of the file, the semantics are to write zeroes from the end of the file to the specified offset and then the data.

On most operating systems, such writes do not allocate disk space but instead leave “holes” in the file.

This function is zero-copy.

pub fn send_write_request_zero_copy2(
    &mut self,
    id: Id<Buffer>,
    handle: Cow<'_, Handle>,
    offset: u64,
    data_slice: &[&[Bytes]]
) -> Result<AwaitableStatus<Buffer>, Error>

Write will extend the file if writing beyond the end of the file.

It is legal to write way beyond the end of the file, the semantics are to write zeroes from the end of the file to the specified offset and then the data.

On most operating systems, such writes do not allocate disk space but instead leave “holes” in the file.

This function is zero-copy.

Methods from Deref<Target = SharedData<Buffer, Q, Auxiliary>>

pub fn queue(&self) -> &Q

pub fn get_auxiliary(&self) -> &Auxiliary

Returned the auxiliary data.

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.

Trait Implementations

impl<Buffer, Q, Auxiliary> Clone for WriteEnd<Buffer, Q, 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, Q: Debug, Auxiliary: Debug> Debug for WriteEnd<Buffer, Q, Auxiliary>

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

Formats the value using the given formatter.

impl<Buffer, Q, Auxiliary> Deref for WriteEnd<Buffer, Q, Auxiliary>

type Target = SharedData<Buffer, Q, Auxiliary>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Buffer, Q, Auxiliary> DerefMut for WriteEnd<Buffer, Q, Auxiliary>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.