Struct ReadOnlyContext 

pub struct ReadOnlyContext<'a>(/* private fields */);

Request, response and read-only KV access for one call of a Registry::read_only handler.

Maps cannot be written:

use ccf_app::{EndpointResult, ReadOnlyContext};

fn write_in_read_only_handler(context: &mut ReadOnlyContext<'_>) -> EndpointResult {
    context.map("records").put(b"key", b"value")?;
    Ok(())
}

Implementations

impl<'ctx> ReadOnlyContext<'ctx>

pub fn body(&self) -> BridgeResult<&[u8]>

Borrow the raw request body. Copy it before calling a &mut self method if it is still needed.

pub fn query(&self) -> BridgeResult<&str>

Borrow the raw query string, without the leading ? and not percent-decoded.

pub fn path_param(&mut self, name: &str) -> BridgeResult<Option<String>>

Copy the decoded path parameter name, such as "key" for /records/{key}, or None if it is absent.

pub fn header(&mut self, name: &str) -> BridgeResult<Option<Vec<u8>>>

Copy the raw value of the request header name, which must be lowercase, or None if it is absent.

pub fn set_status(&mut self, status: u16) -> BridgeResult<()>

Set the response status. Unknown statuses are rejected with BridgeError::InvalidArgument.

pub fn set_header(&mut self, name: &str, value: &str) -> BridgeResult<()>

Set a response header. Invalid names and values, including any containing CR or LF, are rejected with BridgeError::InvalidArgument.

pub fn set_body(&mut self, body: &[u8]) -> BridgeResult<()>

Set the raw response body.

pub fn map<'a>(&'a mut self, name: &'a str) -> ReadOnlyMap<'a, 'ctx>

Access the map name in this call’s transaction.