Struct WasiHttpCtxView 

pub struct WasiHttpCtxView<'a> {
    pub ctx: &'a mut WasiHttpCtx,
    pub table: &'a mut ResourceTable,
    pub hooks: &'a mut dyn WasiHttpHooks,
}

Available on crate feature p2 only.

Structure which wasi:http Host-style traits are implemented for.

This structure is used by embedders with the WasiHttpView trait’s return value and is used to provide access to this crate all internals necessary to implement wasi:http. This is similar to wasmtime_wasi::WasiCtxView for example.

Fields

ctx: &'a mut WasiHttpCtx

A reference to a per-store WasiHttpCtx.

table: &'a mut ResourceTable

A reference to a per-store table of resources to store host structures within.

hooks: &'a mut dyn WasiHttpHooks

A reference to a per-store set of hooks that can be used to customize wasi:http behavior.

Implementations

impl WasiHttpCtxView<'_>

pub fn new_incoming_request<B>( &mut self, scheme: Scheme, req: Request<B>, ) -> Result<Resource<HostIncomingRequest>>

where B: Body<Data = Bytes> + Send + 'static, B::Error: Into<ErrorCode>,

Create a new incoming request resource.

impl WasiHttpCtxView<'_>

pub fn new_response_outparam( &mut self, result: Sender<Result<Response<HyperOutgoingBody>, ErrorCode>>, ) -> Result<Resource<HostResponseOutparam>>

Create a new outgoing response resource.

Trait Implementations

impl Host for WasiHttpCtxView<'_>

fn handle( &mut self, request_id: Resource<HostOutgoingRequest>, options: Option<Resource<RequestOptions>>, ) -> HttpResult<Resource<HostFutureIncomingResponse>>

Available on crate feature component-model-async only.

This function is invoked with an outgoing HTTP Request, and it returns a resource future-incoming-response which represents an HTTP Response which may arrive in the future.

impl Host for WasiHttpCtxView<'_>

fn convert_error_code(&mut self, err: HttpError) -> Result<ErrorCode>

Available on crate feature component-model-async only.

fn convert_header_error(&mut self, err: HeaderError) -> Result<HeaderError>

Available on crate feature component-model-async only.

fn http_error_code( &mut self, err: Resource<IoError>, ) -> Result<Option<ErrorCode>>

Available on crate feature component-model-async only.

Attempts to extract a http-related error from the wasi:io error provided.

impl HostFields for WasiHttpCtxView<'_>

fn new(&mut self) -> Result<Resource<FieldMap>>

Available on crate feature component-model-async only.

Construct an empty HTTP Fields.

fn from_list( &mut self, entries: Vec<(String, Vec<u8>)>, ) -> HeaderResult<Resource<FieldMap>>

Available on crate feature component-model-async only.

Construct an HTTP Fields.

fn drop(&mut self, fields: Resource<FieldMap>) -> Result<()>

Available on crate feature component-model-async only.

fn get( &mut self, fields: Resource<FieldMap>, name: String, ) -> Result<Vec<Vec<u8>>>

Available on crate feature component-model-async only.

Get all of the values corresponding to a name. If the name is not present in this fields or is syntactically invalid, an empty list is returned. However, if the name is present but empty, this is represented by a list with one or more empty field-values present.

fn has(&mut self, fields: Resource<FieldMap>, name: String) -> Result<bool>

Available on crate feature component-model-async only.

Returns true when the name is present in this fields. If the name is syntactically invalid, false is returned.

fn set( &mut self, fields: Resource<FieldMap>, name: String, byte_values: Vec<Vec<u8>>, ) -> HeaderResult<()>

Available on crate feature component-model-async only.

Set all of the values for a name. Clears any existing values for that name, if they have been set.

fn delete( &mut self, fields: Resource<FieldMap>, name: String, ) -> HeaderResult<()>

Available on crate feature component-model-async only.

Delete all values for a name. Does nothing if no values for the name exist.

fn append( &mut self, fields: Resource<FieldMap>, name: String, value: Vec<u8>, ) -> HeaderResult<()>

Available on crate feature component-model-async only.

Append a value for a name. Does not change or delete any existing values for that name.

fn entries( &mut self, fields: Resource<FieldMap>, ) -> Result<Vec<(String, Vec<u8>)>>

Available on crate feature component-model-async only.

Retrieve the full set of names and values in the Fields. Like the constructor, the list represents each name-value pair.

fn clone(&mut self, fields: Resource<FieldMap>) -> Result<Resource<FieldMap>>

Available on crate feature component-model-async only.

Make a deep copy of the Fields. Equivalent in behavior to calling the fields constructor on the return value of entries. The resulting fields is mutable.

impl HostFutureIncomingResponse for WasiHttpCtxView<'_>

fn drop(&mut self, id: Resource<HostFutureIncomingResponse>) -> Result<()>

Available on crate feature component-model-async only.

fn get( &mut self, id: Resource<HostFutureIncomingResponse>, ) -> Result<Option<Result<Result<Resource<HostIncomingResponse>, ErrorCode>, ()>>>

Available on crate feature component-model-async only.

Returns the incoming HTTP Response, or an error, once one is ready.

fn subscribe( &mut self, id: Resource<HostFutureIncomingResponse>, ) -> Result<Resource<DynPollable>>

Available on crate feature component-model-async only.

Returns a pollable which becomes ready when either the Response has been received, or an error has occurred. When this pollable is ready, the get method will return some.

impl HostFutureTrailers for WasiHttpCtxView<'_>

fn drop(&mut self, id: Resource<HostFutureTrailers>) -> Result<()>

Available on crate feature component-model-async only.

fn subscribe( &mut self, index: Resource<HostFutureTrailers>, ) -> Result<Resource<DynPollable>>

Available on crate feature component-model-async only.

Returns a pollable which becomes ready when either the trailers have been received, or an error has occurred. When this pollable is ready, the get method will return some.

fn get( &mut self, id: Resource<HostFutureTrailers>, ) -> Result<Option<Result<Result<Option<Resource<Trailers>>, ErrorCode>, ()>>>

Available on crate feature component-model-async only.

Returns the contents of the trailers, or an error which occurred, once the future is ready.

impl HostIncomingBody for WasiHttpCtxView<'_>

fn stream( &mut self, id: Resource<HostIncomingBody>, ) -> Result<Result<Resource<DynInputStream>, ()>>

Available on crate feature component-model-async only.

Returns the contents of the body, as a stream of bytes.

fn finish( &mut self, id: Resource<HostIncomingBody>, ) -> Result<Resource<HostFutureTrailers>>

Available on crate feature component-model-async only.

Takes ownership of incoming-body, and returns a future-trailers. This function will trap if the input-stream child is still alive.

fn drop(&mut self, id: Resource<HostIncomingBody>) -> Result<()>

Available on crate feature component-model-async only.

impl HostIncomingRequest for WasiHttpCtxView<'_>

fn method(&mut self, id: Resource<HostIncomingRequest>) -> Result<Method>

Available on crate feature component-model-async only.

Returns the method of the incoming request.

fn path_with_query( &mut self, id: Resource<HostIncomingRequest>, ) -> Result<Option<String>>

Available on crate feature component-model-async only.

Returns the path with query parameters from the request, as a string.

fn scheme( &mut self, id: Resource<HostIncomingRequest>, ) -> Result<Option<Scheme>>

Available on crate feature component-model-async only.

Returns the protocol scheme from the request.

fn authority( &mut self, id: Resource<HostIncomingRequest>, ) -> Result<Option<String>>

Available on crate feature component-model-async only.

Returns the authority of the Request’s target URI, if present.

fn headers( &mut self, id: Resource<HostIncomingRequest>, ) -> Result<Resource<FieldMap>>

Available on crate feature component-model-async only.

Get the headers associated with the request.

fn consume( &mut self, id: Resource<HostIncomingRequest>, ) -> Result<Result<Resource<HostIncomingBody>, ()>>

Available on crate feature component-model-async only.

Gives the incoming-body associated with this request. Will only return success at most once, and subsequent calls will return error.

fn drop(&mut self, id: Resource<HostIncomingRequest>) -> Result<()>

Available on crate feature component-model-async only.

impl HostIncomingResponse for WasiHttpCtxView<'_>

fn drop(&mut self, response: Resource<HostIncomingResponse>) -> Result<()>

Available on crate feature component-model-async only.

fn status( &mut self, response: Resource<HostIncomingResponse>, ) -> Result<StatusCode>

Available on crate feature component-model-async only.

Returns the status code from the incoming response.

fn headers( &mut self, response: Resource<HostIncomingResponse>, ) -> Result<Resource<FieldMap>>

Available on crate feature component-model-async only.

Returns the headers from the incoming response.

fn consume( &mut self, response: Resource<HostIncomingResponse>, ) -> Result<Result<Resource<HostIncomingBody>, ()>>

Available on crate feature component-model-async only.

Returns the incoming body. May be called at most once. Returns error if called additional times.

impl HostOutgoingBody for WasiHttpCtxView<'_>

fn write( &mut self, id: Resource<HostOutgoingBody>, ) -> Result<Result<Resource<DynOutputStream>, ()>>

Available on crate feature component-model-async only.

Returns a stream for writing the body contents.

fn finish( &mut self, id: Resource<HostOutgoingBody>, ts: Option<Resource<Trailers>>, ) -> HttpResult<()>

Available on crate feature component-model-async only.

Finalize an outgoing body, optionally providing trailers. This must be called to signal that the response is complete. If the outgoing-body is dropped without calling outgoing-body.finalize, the implementation should treat the body as corrupted.

fn drop(&mut self, id: Resource<HostOutgoingBody>) -> Result<()>

Available on crate feature component-model-async only.

impl HostOutgoingRequest for WasiHttpCtxView<'_>

fn new( &mut self, headers: Resource<FieldMap>, ) -> Result<Resource<HostOutgoingRequest>>

Available on crate feature component-model-async only.

Construct a new outgoing-request with a default method of GET, and none values for path-with-query, scheme, and authority.

fn body( &mut self, request: Resource<HostOutgoingRequest>, ) -> Result<Result<Resource<HostOutgoingBody>, ()>>

Available on crate feature component-model-async only.

Returns the resource corresponding to the outgoing Body for this Request.

fn drop(&mut self, request: Resource<HostOutgoingRequest>) -> Result<()>

Available on crate feature component-model-async only.

fn method(&mut self, request: Resource<OutgoingRequest>) -> Result<Method>

Available on crate feature component-model-async only.

Get the Method for the Request.

fn set_method( &mut self, request: Resource<OutgoingRequest>, method: Method, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the Method for the Request. Fails if the string present in a method.other argument is not a syntactically valid method.

fn path_with_query( &mut self, request: Resource<OutgoingRequest>, ) -> Result<Option<String>>

Available on crate feature component-model-async only.

Get the combination of the HTTP Path and Query for the Request. When none, this represents an empty Path and empty Query.

fn set_path_with_query( &mut self, request: Resource<OutgoingRequest>, path_with_query: Option<String>, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the combination of the HTTP Path and Query for the Request. When none, this represents an empty Path and empty Query. Fails is the string given is not a syntactically valid path and query uri component.

fn scheme( &mut self, request: Resource<OutgoingRequest>, ) -> Result<Option<Scheme>>

Available on crate feature component-model-async only.

Get the HTTP Related Scheme for the Request. When none, the implementation may choose an appropriate default scheme.

fn set_scheme( &mut self, request: Resource<OutgoingRequest>, scheme: Option<Scheme>, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the HTTP Related Scheme for the Request. When none, the implementation may choose an appropriate default scheme. Fails if the string given is not a syntactically valid uri scheme.

fn authority( &mut self, request: Resource<OutgoingRequest>, ) -> Result<Option<String>>

Available on crate feature component-model-async only.

Get the authority of the Request’s target URI. A value of none may be used with Related Schemes which do not require an authority. The HTTP and HTTPS schemes always require an authority.

fn set_authority( &mut self, request: Resource<OutgoingRequest>, authority: Option<String>, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the authority of the Request’s target URI. A value of none may be used with Related Schemes which do not require an authority. The HTTP and HTTPS schemes always require an authority. Fails if the string given is not a syntactically valid URI authority.

fn headers( &mut self, request: Resource<OutgoingRequest>, ) -> Result<Resource<FieldMap>>

Available on crate feature component-model-async only.

Get the headers associated with the Request.

impl HostOutgoingResponse for WasiHttpCtxView<'_>

fn new( &mut self, headers: Resource<FieldMap>, ) -> Result<Resource<HostOutgoingResponse>>

Available on crate feature component-model-async only.

Construct an outgoing-response, with a default status-code of 200. If a different status-code is needed, it must be set via the set-status-code method.

fn body( &mut self, id: Resource<HostOutgoingResponse>, ) -> Result<Result<Resource<HostOutgoingBody>, ()>>

Available on crate feature component-model-async only.

Returns the resource corresponding to the outgoing Body for this Response.

fn status_code( &mut self, id: Resource<HostOutgoingResponse>, ) -> Result<StatusCode>

Available on crate feature component-model-async only.

Get the HTTP Status Code for the Response.

fn set_status_code( &mut self, id: Resource<HostOutgoingResponse>, status: StatusCode, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the HTTP Status Code for the Response. Fails if the status-code given is not a valid http status code.

fn headers( &mut self, id: Resource<HostOutgoingResponse>, ) -> Result<Resource<FieldMap>>

Available on crate feature component-model-async only.

Get the headers associated with the Request.

fn drop(&mut self, id: Resource<HostOutgoingResponse>) -> Result<()>

Available on crate feature component-model-async only.

impl HostRequestOptions for WasiHttpCtxView<'_>

fn new(&mut self) -> Result<Resource<RequestOptions>>

Available on crate feature component-model-async only.

Construct a default request-options value.

fn connect_timeout( &mut self, opts: Resource<RequestOptions>, ) -> Result<Option<Duration>>

Available on crate feature component-model-async only.

The timeout for the initial connect to the HTTP Server.

fn set_connect_timeout( &mut self, opts: Resource<RequestOptions>, duration: Option<Duration>, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the timeout for the initial connect to the HTTP Server. An error return value indicates that this timeout is not supported.

fn first_byte_timeout( &mut self, opts: Resource<RequestOptions>, ) -> Result<Option<Duration>>

Available on crate feature component-model-async only.

The timeout for receiving the first byte of the Response body.

fn set_first_byte_timeout( &mut self, opts: Resource<RequestOptions>, duration: Option<Duration>, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the timeout for receiving the first byte of the Response body. An error return value indicates that this timeout is not supported.

fn between_bytes_timeout( &mut self, opts: Resource<RequestOptions>, ) -> Result<Option<Duration>>

Available on crate feature component-model-async only.

The timeout for receiving subsequent chunks of bytes in the Response body stream.

fn set_between_bytes_timeout( &mut self, opts: Resource<RequestOptions>, duration: Option<Duration>, ) -> Result<Result<(), ()>>

Available on crate feature component-model-async only.

Set the timeout for receiving subsequent chunks of bytes in the Response body stream. An error return value indicates that this timeout is not supported.

fn drop(&mut self, rep: Resource<RequestOptions>) -> Result<()>

Available on crate feature component-model-async only.

impl HostResponseOutparam for WasiHttpCtxView<'_>

fn drop(&mut self, id: Resource<HostResponseOutparam>) -> Result<()>

Available on crate feature component-model-async only.

fn set( &mut self, id: Resource<HostResponseOutparam>, resp: Result<Resource<HostOutgoingResponse>, ErrorCode>, ) -> Result<()>

Available on crate feature component-model-async only.

Set the value of the response-outparam to either send a response, or indicate an error.

fn send_informational( &mut self, _id: Resource<HostResponseOutparam>, _status: u16, _headers: Resource<FieldMap>, ) -> HttpResult<()>

Available on crate feature component-model-async only.

Send an HTTP 1xx response.