| <!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/raw/oio/delete/api.rs`."><title>api.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="opendal" 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">opendal/raw/oio/delete/</div>api.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">crate</span>::raw::{BoxedFuture, MaybeSend, OpDelete}; |
| <a href=#19 id=19 data-nosnippet>19</a><span class="kw">use crate</span>::<span class="kw-2">*</span>; |
| <a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>std::future::Future; |
| <a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>std::ops::DerefMut; |
| <a href=#22 id=22 data-nosnippet>22</a> |
| <a href=#23 id=23 data-nosnippet>23</a><span class="doccomment">/// Deleter is a type erased [`Delete`] |
| <a href=#24 id=24 data-nosnippet>24</a></span><span class="kw">pub type </span>Deleter = Box<<span class="kw">dyn </span>DeleteDyn>; |
| <a href=#25 id=25 data-nosnippet>25</a> |
| <a href=#26 id=26 data-nosnippet>26</a><span class="doccomment">/// The Delete trait defines interfaces for performing deletion operations. |
| <a href=#27 id=27 data-nosnippet>27</a></span><span class="kw">pub trait </span>Delete: Unpin + Send + Sync { |
| <a href=#28 id=28 data-nosnippet>28</a> <span class="doccomment">/// Requests deletion of a resource at the specified path with optional arguments |
| <a href=#29 id=29 data-nosnippet>29</a> /// |
| <a href=#30 id=30 data-nosnippet>30</a> /// # Parameters |
| <a href=#31 id=31 data-nosnippet>31</a> /// - `path`: The path of the resource to delete |
| <a href=#32 id=32 data-nosnippet>32</a> /// - `args`: Additional arguments for the delete operation |
| <a href=#33 id=33 data-nosnippet>33</a> /// |
| <a href=#34 id=34 data-nosnippet>34</a> /// # Returns |
| <a href=#35 id=35 data-nosnippet>35</a> /// - `Ok(())`: The deletion request has been successfully queued (does not guarantee actual deletion) |
| <a href=#36 id=36 data-nosnippet>36</a> /// - `Err(err)`: An error occurred and the deletion request was not queued |
| <a href=#37 id=37 data-nosnippet>37</a> /// |
| <a href=#38 id=38 data-nosnippet>38</a> /// # Notes |
| <a href=#39 id=39 data-nosnippet>39</a> /// This method just queue the delete request. The actual deletion will be |
| <a href=#40 id=40 data-nosnippet>40</a> /// performed when `flush` is called. |
| <a href=#41 id=41 data-nosnippet>41</a> </span><span class="kw">fn </span>delete(<span class="kw-2">&mut </span><span class="self">self</span>, path: <span class="kw-2">&</span>str, args: OpDelete) -> <span class="prelude-ty">Result</span><()>; |
| <a href=#42 id=42 data-nosnippet>42</a> |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="doccomment">/// Flushes the deletion queue to ensure queued deletions are executed |
| <a href=#44 id=44 data-nosnippet>44</a> /// |
| <a href=#45 id=45 data-nosnippet>45</a> /// # Returns |
| <a href=#46 id=46 data-nosnippet>46</a> /// - `Ok(0)`: All queued deletions have been processed or the queue is empty. |
| <a href=#47 id=47 data-nosnippet>47</a> /// - `Ok(count)`: The number of resources successfully deleted. Implementations should |
| <a href=#48 id=48 data-nosnippet>48</a> /// return an error if the queue is non-empty but no resources were deleted |
| <a href=#49 id=49 data-nosnippet>49</a> /// - `Err(err)`: An error occurred while performing the deletions |
| <a href=#50 id=50 data-nosnippet>50</a> /// |
| <a href=#51 id=51 data-nosnippet>51</a> /// # Notes |
| <a href=#52 id=52 data-nosnippet>52</a> /// - This method is asynchronous and will wait for queued deletions to complete |
| <a href=#53 id=53 data-nosnippet>53</a> </span><span class="kw">fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw">impl </span>Future<Output = <span class="prelude-ty">Result</span><usize>> + MaybeSend; |
| <a href=#54 id=54 data-nosnippet>54</a>} |
| <a href=#55 id=55 data-nosnippet>55</a> |
| <a href=#56 id=56 data-nosnippet>56</a><span class="kw">impl </span>Delete <span class="kw">for </span>() { |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">fn </span>delete(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>str, <span class="kw">_</span>: OpDelete) -> <span class="prelude-ty">Result</span><()> { |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="prelude-val">Err</span>(Error::new( |
| <a href=#59 id=59 data-nosnippet>59</a> ErrorKind::Unsupported, |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="string">"output deleter doesn't support delete"</span>, |
| <a href=#61 id=61 data-nosnippet>61</a> )) |
| <a href=#62 id=62 data-nosnippet>62</a> } |
| <a href=#63 id=63 data-nosnippet>63</a> |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="kw">async fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><usize> { |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="prelude-val">Err</span>(Error::new( |
| <a href=#66 id=66 data-nosnippet>66</a> ErrorKind::Unsupported, |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="string">"output deleter doesn't support flush"</span>, |
| <a href=#68 id=68 data-nosnippet>68</a> )) |
| <a href=#69 id=69 data-nosnippet>69</a> } |
| <a href=#70 id=70 data-nosnippet>70</a>} |
| <a href=#71 id=71 data-nosnippet>71</a> |
| <a href=#72 id=72 data-nosnippet>72</a><span class="doccomment">/// The dyn version of [`Delete`] |
| <a href=#73 id=73 data-nosnippet>73</a></span><span class="kw">pub trait </span>DeleteDyn: Unpin + Send + Sync { |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="doccomment">/// The dyn version of [`Delete::delete`] |
| <a href=#75 id=75 data-nosnippet>75</a> </span><span class="kw">fn </span>delete_dyn(<span class="kw-2">&mut </span><span class="self">self</span>, path: <span class="kw-2">&</span>str, args: OpDelete) -> <span class="prelude-ty">Result</span><()>; |
| <a href=#76 id=76 data-nosnippet>76</a> |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="doccomment">/// The dyn version of [`Delete::flush`] |
| <a href=#78 id=78 data-nosnippet>78</a> </span><span class="kw">fn </span>flush_dyn(<span class="kw-2">&mut </span><span class="self">self</span>) -> BoxedFuture<<span class="prelude-ty">Result</span><usize>>; |
| <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><span class="kw">impl</span><T: Delete + <span class="question-mark">?</span>Sized> DeleteDyn <span class="kw">for </span>T { |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">fn </span>delete_dyn(<span class="kw-2">&mut </span><span class="self">self</span>, path: <span class="kw-2">&</span>str, args: OpDelete) -> <span class="prelude-ty">Result</span><()> { |
| <a href=#83 id=83 data-nosnippet>83</a> Delete::delete(<span class="self">self</span>, path, args) |
| <a href=#84 id=84 data-nosnippet>84</a> } |
| <a href=#85 id=85 data-nosnippet>85</a> |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="kw">fn </span>flush_dyn(<span class="kw-2">&mut </span><span class="self">self</span>) -> BoxedFuture<<span class="prelude-ty">Result</span><usize>> { |
| <a href=#87 id=87 data-nosnippet>87</a> Box::pin(<span class="self">self</span>.flush()) |
| <a href=#88 id=88 data-nosnippet>88</a> } |
| <a href=#89 id=89 data-nosnippet>89</a>} |
| <a href=#90 id=90 data-nosnippet>90</a> |
| <a href=#91 id=91 data-nosnippet>91</a><span class="kw">impl</span><T: DeleteDyn + <span class="question-mark">?</span>Sized> Delete <span class="kw">for </span>Box<T> { |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="kw">fn </span>delete(<span class="kw-2">&mut </span><span class="self">self</span>, path: <span class="kw-2">&</span>str, args: OpDelete) -> <span class="prelude-ty">Result</span><()> { |
| <a href=#93 id=93 data-nosnippet>93</a> <span class="self">self</span>.deref_mut().delete_dyn(path, args) |
| <a href=#94 id=94 data-nosnippet>94</a> } |
| <a href=#95 id=95 data-nosnippet>95</a> |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="kw">async fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><usize> { |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="self">self</span>.deref_mut().flush_dyn().<span class="kw">await |
| <a href=#98 id=98 data-nosnippet>98</a> </span>} |
| <a href=#99 id=99 data-nosnippet>99</a>}</code></pre></div></section></main></body></html> |
