rusftp 0.2.1

SFTP library based on russh
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

// This file is part of the rusftp project
//
// Copyright (C) ANEO, 2024-2024. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::future::Future;
use std::pin::Pin;
use std::task::ready;

use crate::client::Error;
use crate::message::{NameEntry, ReadDir, Status, StatusCode};

use super::Dir;

impl futures::Stream for Dir {
    type Item = Result<NameEntry, Error>;

    fn poll_next(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        // If end of file reached, return None
        let Some(buffer) = &mut self.buffer else {
            return std::task::Poll::Ready(None);
        };

        // If still some entries in the buffer, get next
        if let Some(entry) = buffer.0.pop() {
            return std::task::Poll::Ready(Some(Ok(entry)));
        }

        let result = match &mut self.pending {
            Some(pending) => {
                ready!(Pin::new(pending).poll(cx))
            }
            None => {
                let Some(handle) = &self.handle else {
                    // Force end of iteration
                    self.buffer = None;
                    return std::task::Poll::Ready(Some(Err(std::io::Error::new(
                        std::io::ErrorKind::BrokenPipe,
                        "Dir was closed",
                    )
                    .into())));
                };

                let readdir = self.client.request(ReadDir {
                    handle: handle.clone(),
                });
                let pending = self.pending.insert(readdir);

                ready!(Pin::new(pending).poll(cx))
            }
        };

        // Polling has finished, resetting pending
        self.pending = None;

        // If the read was successful, the buffer will be populated again
        // Stop the iteration otherwise
        self.buffer = None;

        let result = match result {
            Ok(mut entries) => {
                entries.reverse();

                if let Some(entry) = entries.0.pop() {
                    self.buffer = Some(entries);
                    Some(Ok(entry))
                } else {
                    Some(Err(std::io::Error::new(
                        std::io::ErrorKind::UnexpectedEof,
                        "Found no more directory entries while it was expecting some",
                    )
                    .into()))
                }
            }
            Err(Error::Sftp(Status {
                code: StatusCode::Eof,
                ..
            })) => None,
            Err(err) => Some(Err(err)),
        };

        std::task::Poll::Ready(result)
    }
}