blob: 2cb6bc01418460a36da39dc632d5d49607c48b19 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/dir.rs`."><title>dir.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-916cea96.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="dav_server_opendalfs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.87.0-nightly (43a2e9d2c 2025-03-17)" data-channel="nightly" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js" ><script src="../../static.files/storage-d8ac8691.js"></script><script defer src="../../static.files/src-script-b8d3f215.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-fb8c74a8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">dav_server_opendalfs/</div>dir.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one
<a href=#2 id=2 data-nosnippet>2</a>// or more contributor license agreements. See the NOTICE file
<a href=#3 id=3 data-nosnippet>3</a>// distributed with this work for additional information
<a href=#4 id=4 data-nosnippet>4</a>// regarding copyright ownership. The ASF licenses this file
<a href=#5 id=5 data-nosnippet>5</a>// to you under the Apache License, Version 2.0 (the
<a href=#6 id=6 data-nosnippet>6</a>// "License"); you may not use this file except in compliance
<a href=#7 id=7 data-nosnippet>7</a>// with the License. You may obtain a copy of the License at
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#10 id=10 data-nosnippet>10</a>//
<a href=#11 id=11 data-nosnippet>11</a>// Unless required by applicable law or agreed to in writing,
<a href=#12 id=12 data-nosnippet>12</a>// software distributed under the License is distributed on an
<a href=#13 id=13 data-nosnippet>13</a>// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
<a href=#14 id=14 data-nosnippet>14</a>// KIND, either express or implied. See the License for the
<a href=#15 id=15 data-nosnippet>15</a>// specific language governing permissions and limitations
<a href=#16 id=16 data-nosnippet>16</a>// under the License.
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">use </span><span class="kw">super</span>::metadata::OpendalMetaData;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span><span class="kw">super</span>::utils::<span class="kw-2">*</span>;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>dav_server::fs::{DavDirEntry, DavMetaData, FsResult};
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>futures::StreamExt;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>futures::{FutureExt, Stream};
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>opendal::raw::normalize_path;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>opendal::Operator;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>opendal::{Entry, Lister};
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>std::pin::Pin;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span>std::task::Poll::Ready;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span>std::task::{ready, Context, Poll};
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a><span class="doccomment">/// OpendalStream is a stream of `DavDirEntry` that is used to list the contents of a directory.
<a href=#31 id=31 data-nosnippet>31</a></span><span class="kw">pub struct </span>OpendalStream {
<a href=#32 id=32 data-nosnippet>32</a> op: Operator,
<a href=#33 id=33 data-nosnippet>33</a> lister: Lister,
<a href=#34 id=34 data-nosnippet>34</a> path: String,
<a href=#35 id=35 data-nosnippet>35</a>}
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a><span class="kw">impl </span>OpendalStream {
<a href=#38 id=38 data-nosnippet>38</a> <span class="doccomment">/// Create a new opendal stream.
<a href=#39 id=39 data-nosnippet>39</a> </span><span class="kw">pub fn </span>new(op: Operator, lister: Lister, p: <span class="kw-2">&amp;</span>str) -&gt; <span class="self">Self </span>{
<a href=#40 id=40 data-nosnippet>40</a> OpendalStream {
<a href=#41 id=41 data-nosnippet>41</a> op,
<a href=#42 id=42 data-nosnippet>42</a> lister,
<a href=#43 id=43 data-nosnippet>43</a> path: normalize_path(p),
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a> }
<a href=#46 id=46 data-nosnippet>46</a>}
<a href=#47 id=47 data-nosnippet>47</a>
<a href=#48 id=48 data-nosnippet>48</a><span class="kw">impl </span>Stream <span class="kw">for </span>OpendalStream {
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">type </span>Item = FsResult&lt;Box&lt;<span class="kw">dyn </span>DavDirEntry&gt;&gt;;
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">fn </span>poll_next(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">'_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt;&gt; {
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>dav_stream = <span class="self">self</span>.get_mut();
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">loop </span>{
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">match </span><span class="macro">ready!</span>(dav_stream.lister.poll_next_unpin(cx)) {
<a href=#55 id=55 data-nosnippet>55</a> <span class="prelude-val">Some</span>(entry) =&gt; {
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">let </span>entry = entry.map_err(convert_error)<span class="question-mark">?</span>;
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">if </span>entry.path() == dav_stream.path {
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">continue</span>;
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span>webdav_entry = OpendalDirEntry::new(dav_stream.op.clone(), entry);
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">return </span>Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(Box::new(webdav_entry) <span class="kw">as </span>Box&lt;<span class="kw">dyn </span>DavDirEntry&gt;)));
<a href=#62 id=62 data-nosnippet>62</a> }
<a href=#63 id=63 data-nosnippet>63</a> <span class="prelude-val">None </span>=&gt; <span class="kw">return </span>Ready(<span class="prelude-val">None</span>),
<a href=#64 id=64 data-nosnippet>64</a> }
<a href=#65 id=65 data-nosnippet>65</a> }
<a href=#66 id=66 data-nosnippet>66</a> }
<a href=#67 id=67 data-nosnippet>67</a>}
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a><span class="doccomment">/// OpendalDirEntry is a `DavDirEntry` implementation for opendal.
<a href=#70 id=70 data-nosnippet>70</a></span><span class="kw">pub struct </span>OpendalDirEntry {
<a href=#71 id=71 data-nosnippet>71</a> op: Operator,
<a href=#72 id=72 data-nosnippet>72</a> dir_entry: Entry,
<a href=#73 id=73 data-nosnippet>73</a>}
<a href=#74 id=74 data-nosnippet>74</a>
<a href=#75 id=75 data-nosnippet>75</a><span class="kw">impl </span>OpendalDirEntry {
<a href=#76 id=76 data-nosnippet>76</a> <span class="doccomment">/// Create a new opendal dir entry.
<a href=#77 id=77 data-nosnippet>77</a> </span><span class="kw">pub fn </span>new(op: Operator, dir_entry: Entry) -&gt; <span class="self">Self </span>{
<a href=#78 id=78 data-nosnippet>78</a> OpendalDirEntry { dir_entry, op }
<a href=#79 id=79 data-nosnippet>79</a> }
<a href=#80 id=80 data-nosnippet>80</a>}
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a><span class="kw">impl </span>DavDirEntry <span class="kw">for </span>OpendalDirEntry {
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;u8&gt; {
<a href=#84 id=84 data-nosnippet>84</a> <span class="self">self</span>.dir_entry.name().as_bytes().to_vec()
<a href=#85 id=85 data-nosnippet>85</a> }
<a href=#86 id=86 data-nosnippet>86</a>
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">fn </span>metadata(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; dav_server::fs::FsFuture&lt;Box&lt;<span class="kw">dyn </span>DavMetaData&gt;&gt; {
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">async move </span>{
<a href=#89 id=89 data-nosnippet>89</a> <span class="self">self</span>.op
<a href=#90 id=90 data-nosnippet>90</a> .stat(<span class="self">self</span>.dir_entry.path())
<a href=#91 id=91 data-nosnippet>91</a> .<span class="kw">await
<a href=#92 id=92 data-nosnippet>92</a> </span>.map(|metadata| Box::new(OpendalMetaData::new(metadata)) <span class="kw">as </span>Box&lt;<span class="kw">dyn </span>DavMetaData&gt;)
<a href=#93 id=93 data-nosnippet>93</a> .map_err(convert_error)
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a> .boxed()
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a>}</code></pre></div></section></main></body></html>