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 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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 http::Request;
use crate::raw::*;
use crate::*;
/// Reply for `create_dir` operation
#[derive(Debug, Clone, Default)]
pub struct RpCreateDir {}
/// Reply for `delete` operation
#[derive(Debug, Clone, Default)]
pub struct RpDelete {}
/// Reply for `list` operation.
#[derive(Debug, Clone, Default)]
pub struct RpList {}
/// Reply for `presign` operation.
#[derive(Debug, Clone)]
pub struct RpPresign {
req: PresignedRequest,
}
impl RpPresign {
/// Create a new reply for `presign`.
pub fn new(req: PresignedRequest) -> Self {
RpPresign { req }
}
/// Consume reply to build a presigned request.
pub fn into_presigned_request(self) -> PresignedRequest {
self.req
}
}
/// PresignedRequest is a presigned request return by `presign`.
#[derive(Debug, Clone)]
pub struct PresignedRequest {
method: http::Method,
uri: http::Uri,
headers: http::HeaderMap,
}
impl PresignedRequest {
/// Create a new PresignedRequest
pub fn new(method: http::Method, uri: http::Uri, headers: http::HeaderMap) -> Self {
Self {
method,
uri,
headers,
}
}
/// Return request's method.
pub fn method(&self) -> &http::Method {
&self.method
}
/// Return request's uri.
pub fn uri(&self) -> &http::Uri {
&self.uri
}
/// Return request's header.
pub fn header(&self) -> &http::HeaderMap {
&self.headers
}
}
impl<T: Default> From<PresignedRequest> for Request<T> {
fn from(v: PresignedRequest) -> Self {
let mut builder = Request::builder().method(v.method).uri(v.uri);
let headers = builder.headers_mut().expect("header map must be valid");
headers.extend(v.headers);
builder
.body(T::default())
.expect("request must build succeed")
}
}
/// Reply for `read` operation.
#[derive(Debug, Clone, Default)]
pub struct RpRead {
/// Size is the size of the reader returned by this read operation.
///
/// - `Some(size)` means the reader has at most size bytes.
/// - `None` means the reader has unknown size.
///
/// It's ok to leave size as empty, but it's recommended to set size if possible. We will use
/// this size as hint to do some optimization like avoid an extra stat or read.
size: Option<u64>,
/// Range is the range of the reader returned by this read operation.
///
/// - `Some(range)` means the reader's content range inside the whole file.
/// - `None` means the reader's content range is unknown.
///
/// It's ok to leave range as empty, but it's recommended to set range if possible. We will use
/// this range as hint to do some optimization like avoid an extra stat or read.
range: Option<BytesContentRange>,
}
impl RpRead {
/// Create a new reply for `read`.
pub fn new() -> Self {
RpRead::default()
}
/// Got the size of the reader returned by this read operation.
///
/// - `Some(size)` means the reader has at most size bytes.
/// - `None` means the reader has unknown size.
pub fn size(&self) -> Option<u64> {
self.size
}
/// Set the size of the reader returned by this read operation.
pub fn with_size(mut self, size: Option<u64>) -> Self {
self.size = size;
self
}
/// Got the range of the reader returned by this read operation.
///
/// - `Some(range)` means the reader has content range inside the whole file.
/// - `None` means the reader has unknown size.
pub fn range(&self) -> Option<BytesContentRange> {
self.range
}
/// Set the range of the reader returned by this read operation.
pub fn with_range(mut self, range: Option<BytesContentRange>) -> Self {
self.range = range;
self
}
}
/// Reply for `stat` operation.
#[derive(Debug, Clone)]
pub struct RpStat {
meta: Metadata,
}
impl RpStat {
/// Create a new reply for `stat`.
pub fn new(meta: Metadata) -> Self {
RpStat { meta }
}
/// Operate on inner metadata.
pub fn map_metadata(mut self, f: impl FnOnce(Metadata) -> Metadata) -> Self {
self.meta = f(self.meta);
self
}
/// Consume RpStat to get the inner metadata.
pub fn into_metadata(self) -> Metadata {
self.meta
}
}
/// Reply for `write` operation.
#[derive(Debug, Clone, Default)]
pub struct RpWrite {}
impl RpWrite {
/// Create a new reply for `write`.
pub fn new() -> Self {
Self {}
}
}
/// Reply for `copy` operation.
#[derive(Debug, Clone, Default)]
pub struct RpCopy {}
impl RpCopy {
/// Create a new reply for `copy`.
pub fn new() -> Self {
Self {}
}
}
/// Reply for `rename` operation.
#[derive(Debug, Clone, Default)]
pub struct RpRename {}
impl RpRename {
/// Create a new reply for `rename`.
pub fn new() -> Self {
Self {}
}
}
#[cfg(test)]
mod tests {
use anyhow::Result;
use http::header::CONTENT_LENGTH;
use http::header::CONTENT_TYPE;
use http::HeaderMap;
use http::Method;
use http::Uri;
use super::*;
#[test]
fn test_presigned_request_convert() -> Result<()> {
let pr = PresignedRequest {
method: Method::PATCH,
uri: Uri::from_static("https://opendal.apache.org/path/to/file"),
headers: {
let mut headers = HeaderMap::new();
headers.insert(CONTENT_LENGTH, "123".parse()?);
headers.insert(CONTENT_TYPE, "application/json".parse()?);
headers
},
};
let req: Request<Buffer> = pr.into();
assert_eq!(Method::PATCH, req.method());
assert_eq!(
"https://opendal.apache.org/path/to/file",
req.uri().to_string()
);
assert_eq!("123", req.headers().get(CONTENT_LENGTH).unwrap());
assert_eq!("application/json", req.headers().get(CONTENT_TYPE).unwrap());
Ok(())
}
}