forked/hyper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(ffi): expand URI documentation

Browse Source
This commit is contained in:
Sean McArthur
2021-09-16 10:00:38 -07:00
parent a54689b921
commit 949216f583
2 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
capi/include/hyper.h
View File

@@ -425,6 +425,19 @@ enum hyper_code hyper_request_set_method(struct hyper_request *req,
/* /*
Set the URI of the request. Set the URI of the request.
The request's URI is best described as the `request-target` from the RFCs. So in HTTP/1,
whatever is set will get sent as-is in the first line (GET $uri HTTP/1.1). It
supports the 4 defined variants, origin-form, absolute-form, authority-form, and
asterisk-form.
The underlying type was built to efficiently support HTTP/2 where the request-target is
split over :scheme, :authority, and :path. As such, each part can be set explicitly, or the
type can parse a single contiguous string and if a scheme is found, that slot is "set". If
the string just starts with a path, only the path portion is set. All pseudo headers that
have been parsed/set are sent when the connection type is HTTP/2.
To set each slot explicitly, use `hyper_request_set_uri_parts`.
*/ */
enum hyper_code hyper_request_set_uri(struct hyper_request *req, enum hyper_code hyper_request_set_uri(struct hyper_request *req,
const uint8_t *uri, const uint8_t *uri,

13
src/ffi/http_types.rs
View File

@@ -73,6 +73,19 @@ ffi_fn! {
ffi_fn! { ffi_fn! {
/// Set the URI of the request. /// Set the URI of the request.
///
/// The request's URI is best described as the `request-target` from the RFCs. So in HTTP/1,
/// whatever is set will get sent as-is in the first line (GET $uri HTTP/1.1). It
/// supports the 4 defined variants, origin-form, absolute-form, authority-form, and
/// asterisk-form.
///
/// The underlying type was built to efficiently support HTTP/2 where the request-target is
/// split over :scheme, :authority, and :path. As such, each part can be set explicitly, or the
/// type can parse a single contiguous string and if a scheme is found, that slot is "set". If
/// the string just starts with a path, only the path portion is set. All pseudo headers that
/// have been parsed/set are sent when the connection type is HTTP/2.
///
/// To set each slot explicitly, use `hyper_request_set_uri_parts`.
fn hyper_request_set_uri(req: *mut hyper_request, uri: *const u8, uri_len: size_t) -> hyper_code { fn hyper_request_set_uri(req: *mut hyper_request, uri: *const u8, uri_len: size_t) -> hyper_code {
let bytes = unsafe { let bytes = unsafe {
std::slice::from_raw_parts(uri, uri_len as usize) std::slice::from_raw_parts(uri, uri_len as usize)